<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.9.4"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>Flow-IPC: session/detail/session_base.hpp Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr id="projectrow">
  <td id="projectalign">
   <div id="projectname">Flow-IPC<span id="projectnumber">&#160;2.0.0</span>
   </div>
   <div id="projectbrief">Flow-IPC project: Full implementation reference.</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.9.4 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search",'Search','.html');
/* @license-end */
</script>
<script type="text/javascript" src="menudata.js"></script>
<script type="text/javascript" src="menu.js"></script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
  initMenu('',true,false,'search.php','Search');
  $(document).ready(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
     onmouseover="return searchBox.OnSearchSelectShow()"
     onmouseout="return searchBox.OnSearchSelectHide()"
     onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>

<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0" 
        name="MSearchResults" id="MSearchResults">
</iframe>
</div>

<div id="nav-path" class="navpath">
  <ul>
<li class="navelem"><a class="el" href="dir_938858dd290fe54e59e3500689c41d32.html">session</a></li><li class="navelem"><a class="el" href="dir_b920fd4362476866a1b4325a80ed2bf5.html">detail</a></li>  </ul>
</div>
</div><!-- top -->
<div class="header">
  <div class="headertitle"><div class="title">session_base.hpp</div></div>
</div><!--header-->
<div class="contents">
<a href="session__base_8hpp.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno">    1</span><span class="comment">/* Flow-IPC: Sessions</span></div>
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno">    2</span><span class="comment"> * Copyright 2023 Akamai Technologies, Inc.</span></div>
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno">    3</span><span class="comment"> *</span></div>
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno">    4</span><span class="comment"> * Licensed under the Apache License, Version 2.0 (the</span></div>
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno">    5</span><span class="comment"> * &quot;License&quot;); you may not use this file except in</span></div>
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno">    6</span><span class="comment"> * compliance with the License.  You may obtain a copy</span></div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno">    7</span><span class="comment"> * of the License at</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno">    8</span><span class="comment"> *</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno">    9</span><span class="comment"> *   https://www.apache.org/licenses/LICENSE-2.0</span></div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno">   10</span><span class="comment"> *</span></div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno">   11</span><span class="comment"> * Unless required by applicable law or agreed to in</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno">   12</span><span class="comment"> * writing, software distributed under the License is</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno">   13</span><span class="comment"> * distributed on an &quot;AS IS&quot; BASIS, WITHOUT WARRANTIES OR</span></div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno">   14</span><span class="comment"> * CONDITIONS OF ANY KIND, either express or implied.</span></div>
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno">   15</span><span class="comment"> * See the License for the specific language governing</span></div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno">   16</span><span class="comment"> * permissions and limitations under the License. */</span></div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno">   17</span><span class="comment"></span> </div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno">   18</span><span class="comment">/// @file</span></div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno">   19</span><span class="comment"></span><span class="preprocessor">#pragma once</span></div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno">   20</span> </div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno">   21</span><span class="preprocessor">#include &quot;<a class="code" href="detail_2session__fwd_8hpp.html">ipc/session/detail/session_fwd.hpp</a>&quot;</span></div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno">   22</span><span class="preprocessor">#include &quot;<a class="code" href="session__shared__name_8hpp.html">ipc/session/detail/session_shared_name.hpp</a>&quot;</span></div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno">   23</span><span class="preprocessor">#include &quot;ipc/session/schema/detail/session_master_channel.capnp.h&quot;</span></div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno">   24</span><span class="preprocessor">#include &quot;<a class="code" href="app_8hpp.html">ipc/session/app.hpp</a>&quot;</span></div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno">   25</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__session_2src_2ipc_2session_2error_8hpp.html">ipc/session/error.hpp</a>&quot;</span></div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno">   26</span><span class="preprocessor">#include &quot;<a class="code" href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">ipc/transport/struc/channel.hpp</a>&quot;</span></div>
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno">   27</span><span class="preprocessor">#include &quot;<a class="code" href="native__socket__stream__acceptor_8hpp.html">ipc/transport/native_socket_stream_acceptor.hpp</a>&quot;</span></div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno">   28</span><span class="preprocessor">#include &quot;<a class="code" href="sync__io_2native__socket__stream_8hpp.html">ipc/transport/sync_io/native_socket_stream.hpp</a>&quot;</span></div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno">   29</span><span class="preprocessor">#include &lt;boost/thread/future.hpp&gt;</span></div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno">   30</span> </div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno">   31</span><span class="keyword">namespace </span><a class="code hl_namespace" href="namespaceipc_1_1session.html">ipc::session</a></div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno">   32</span>{</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno">   33</span> </div>
<div class="line"><a id="l00034" name="l00034"></a><span class="lineno">   34</span><span class="comment">// Types.</span></div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno">   35</span><span class="comment"></span> </div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno">   36</span><span class="comment">/**</span></div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno">   37</span><span class="comment"> * Internal type containing data and types common to internal types Server_session_impl and Client_session_impl</span></div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno">   38</span><span class="comment"> * which are the respective true cores of #Server_session and #Client_session respectively.</span></div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno">   39</span><span class="comment"> *</span></div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno">   40</span><span class="comment"> * A Server_session_impl and Client_session_impl share many basic properties, some public.  For example consider</span></div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno">   41</span><span class="comment"> * that a Server_session_impl on this side has 1 counterpart Client_session_impl on the other side (or vice versa); for</span></div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno">   42</span><span class="comment"> * both it is salient which Server_app is on the server side and which Client_app is on the client side.</span></div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno">   43</span><span class="comment"> * In terms of types/constants, on each side the two Session objects must be identically configured via various</span></div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno">   44</span><span class="comment"> * template params which results in non-trivial type aliases like the highly significant #Channel_obj,</span></div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno">   45</span><span class="comment"> * exposed in the Session concept, and constants like #S_SOCKET_STREAM_ENABLED.</span></div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno">   46</span><span class="comment"> *</span></div>
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno">   47</span><span class="comment"> * Regarding data: an operational (PEER-state) Session (on either end) will need various members to be set</span></div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno">   48</span><span class="comment"> * before it is indeed in PEER state.  This object stores such data, usually unset at first, and features</span></div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno">   49</span><span class="comment"> * `protected` setters to invoke once each, until all are set permanently for PEER state.</span></div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno">   50</span><span class="comment"> *</span></div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno">   51</span><span class="comment"> * Session_base also has a `protected` inner class, Session_base::Graceful_finisher which certain variations</span></div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno">   52</span><span class="comment"> * (for which this is necessary) of Server_session_impl and Client_session_impl use to carry out a</span></div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno">   53</span><span class="comment"> * graceful-session-end handshake procedure.  This is here in Session_base -- despite being somewhat more</span></div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno">   54</span><span class="comment"> * algorithmic/stateful than the other stuff here -- essentially because the Graceful_finisher (if needed at</span></div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno">   55</span><span class="comment"> * all) on each side acts completely symmetrically.  Other items tend to be (internally) asymmetrical in</span></div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno">   56</span><span class="comment"> * behavior between Server_session_impl and Client_session_impl (and variants).  More info on</span></div>
<div class="line"><a id="l00057" name="l00057"></a><span class="lineno">   57</span><span class="comment"> * Session_base::Graceful_finisher in its own doc header.</span></div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno">   58</span><span class="comment"> *</span></div>
<div class="line"><a id="l00059" name="l00059"></a><span class="lineno">   59</span><span class="comment"> * @tparam Mdt_payload</span></div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno">   60</span><span class="comment"> *         See #Server_session, #Client_session (or Session concept).</span></div>
<div class="line"><a id="l00061" name="l00061"></a><span class="lineno">   61</span><span class="comment"> * @tparam S_MQ_TYPE_OR_NONE</span></div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno">   62</span><span class="comment"> *         See #Server_session, #Client_session.</span></div>
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno">   63</span><span class="comment"> * @tparam S_TRANSMIT_NATIVE_HANDLES</span></div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno">   64</span><span class="comment"> *         See #Server_session, #Client_session.</span></div>
<div class="line"><a id="l00065" name="l00065"></a><span class="lineno">   65</span><span class="comment"> */</span></div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno">   66</span><span class="keyword">template</span>&lt;schema::MqType S_MQ_TYPE_OR_NONE, <span class="keywordtype">bool</span> S_TRANSMIT_NATIVE_HANDLES, <span class="keyword">typename</span> Mdt_payload&gt;</div>
<div class="line"><a id="l00067" name="l00067"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html">   67</a></span><span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1Session__base.html">Session_base</a> :</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno">   68</span>  <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00069" name="l00069"></a><span class="lineno">   69</span>{</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno">   70</span><span class="keyword">public</span>:</div>
<div class="line"><a id="l00071" name="l00071"></a><span class="lineno">   71</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno">   72</span><span class="comment"></span> </div>
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno">   73</span><span class="comment">  /// See Session_mv.</span></div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a27a5731a648effb6b4b42f0312affa74">   74</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a27a5731a648effb6b4b42f0312affa74">S_MQS_ENABLED</a> = S_MQ_TYPE_OR_NONE != schema::MqType::NONE;</div>
<div class="line"><a id="l00075" name="l00075"></a><span class="lineno">   75</span><span class="comment"></span> </div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno">   76</span><span class="comment">  /// See Session_mv.</span></div>
<div class="line"><a id="l00077" name="l00077"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a1f7c4243c8bd55930f51a568884c8aaf">   77</a></span><span class="comment"></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">bool</span> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a1f7c4243c8bd55930f51a568884c8aaf">S_SOCKET_STREAM_ENABLED</a> = (!<a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a27a5731a648effb6b4b42f0312affa74">S_MQS_ENABLED</a>) || S_TRANSMIT_NATIVE_HANDLES;</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno">   78</span> </div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno">   79</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno">   80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno">   81</span>  <span class="keyword">static_assert</span>(S_MQ_TYPE_OR_NONE != schema::MqType::END_SENTINEL,</div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno">   82</span>                <span class="stringliteral">&quot;Do not use the value END_SENTINEL for S_MQ_TYPE_OR_NONE; it is only a sentinel.  Did you mean NONE?&quot;</span>);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno">   83</span> </div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno">   84</span>  <span class="comment">// Ensure the definitions immediately following are based on correct assumptions.</span></div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno">   85</span>  <span class="keyword">static_assert</span>(std::is_enum_v&lt;schema::MqType&gt;,</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno">   86</span>                <span class="stringliteral">&quot;Sanity-checking capnp-generated MqType enum (must be an enum).&quot;</span>);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno">   87</span>  <span class="keyword">static_assert</span>(std::is_unsigned_v&lt;std::underlying_type_t&lt;schema::MqType&gt;&gt;,</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno">   88</span>                <span class="stringliteral">&quot;Sanity-checking capnp-generated MqType enum (backing type must be unsigned).&quot;</span>);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno">   89</span>  <span class="keyword">static_assert</span>((int(schema::MqType::END_SENTINEL) - 1) == 2,</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno">   90</span>                <span class="stringliteral">&quot;Code apparently must be updated -- expected exactly 2 MqType enum values plus NONE + sentinel.&quot;</span>);</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno">   91</span>  <span class="keyword">static_assert</span>((int(schema::MqType::POSIX) != int(schema::MqType::BIPC))</div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno">   92</span>                 &amp;&amp; (<span class="keywordtype">int</span>(schema::MqType::POSIX) &gt; int(schema::MqType::NONE))</div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno">   93</span>                 &amp;&amp; (<span class="keywordtype">int</span>(schema::MqType::BIPC) &gt; int(schema::MqType::NONE))</div>
<div class="line"><a id="l00094" name="l00094"></a><span class="lineno">   94</span>                 &amp;&amp; (<span class="keywordtype">int</span>(schema::MqType::POSIX) &lt; int(schema::MqType::END_SENTINEL))</div>
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno">   95</span>                 &amp;&amp; (<span class="keywordtype">int</span>(schema::MqType::BIPC) &lt; int(schema::MqType::END_SENTINEL)),</div>
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno">   96</span>                <span class="stringliteral">&quot;Code apparently must be updated -- &quot;</span></div>
<div class="line"><a id="l00097" name="l00097"></a><span class="lineno">   97</span>                  <span class="stringliteral">&quot;expected exactly 2 particular MqType enum values plus NONE + sentinel.&quot;</span>);</div>
<div class="line"><a id="l00098" name="l00098"></a><span class="lineno">   98</span><span class="comment"></span> </div>
<div class="line"><a id="l00099" name="l00099"></a><span class="lineno">   99</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00100" name="l00100"></a><span class="lineno">  100</span><span class="comment">   * Relevant only if #S_MQS_ENABLED, this is the Persistent_mq_handle-concept impl type specified by</span></div>
<div class="line"><a id="l00101" name="l00101"></a><span class="lineno">  101</span><span class="comment">   * the user via `S_MQ_TYPE_OR_NONE`.</span></div>
<div class="line"><a id="l00102" name="l00102"></a><span class="lineno">  102</span><span class="comment">   */</span></div>
<div class="line"><a id="l00103" name="l00103"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a848c0f5247644ada0f8b0ab816eedda8">  103</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a848c0f5247644ada0f8b0ab816eedda8">Persistent_mq_handle_from_cfg</a></div>
<div class="line"><a id="l00104" name="l00104"></a><span class="lineno">  104</span>    = std::conditional_t&lt;!<a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a27a5731a648effb6b4b42f0312affa74">S_MQS_ENABLED</a>,</div>
<div class="line"><a id="l00105" name="l00105"></a><span class="lineno">  105</span>                         <a class="code hl_class" href="classipc_1_1transport_1_1Null__peer.html">transport::Null_peer</a>,</div>
<div class="line"><a id="l00106" name="l00106"></a><span class="lineno">  106</span>                         std::conditional_t&lt;S_MQ_TYPE_OR_NONE == schema::MqType::POSIX,</div>
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno">  107</span>                                            <a class="code hl_class" href="classipc_1_1transport_1_1Posix__mq__handle.html">transport::Posix_mq_handle</a>,</div>
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno">  108</span>                                            <a class="code hl_class" href="classipc_1_1transport_1_1Bipc__mq__handle.html">transport::Bipc_mq_handle</a>&gt;&gt;;</div>
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno">  109</span><span class="comment"></span> </div>
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno">  110</span><span class="comment">  /// See Session_mv (or Session concept).</span></div>
<div class="line"><a id="l00111" name="l00111"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a71f02a809d667c23ff8af29a96940bd1">  111</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a71f02a809d667c23ff8af29a96940bd1">Channel_obj</a> = std::conditional_t&lt;<a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a27a5731a648effb6b4b42f0312affa74">S_MQS_ENABLED</a>,</div>
<div class="line"><a id="l00112" name="l00112"></a><span class="lineno">  112</span>                                         std::conditional_t</div>
<div class="line"><a id="l00113" name="l00113"></a><span class="lineno">  113</span>                                           &lt;S_TRANSMIT_NATIVE_HANDLES,</div>
<div class="line"><a id="l00114" name="l00114"></a><span class="lineno">  114</span>                                            <a class="code hl_class" href="classipc_1_1transport_1_1Mqs__socket__stream__channel.html">transport::Mqs_socket_stream_channel&lt;true, Persistent_mq_handle_from_cfg&gt;</a>,</div>
<div class="line"><a id="l00115" name="l00115"></a><span class="lineno">  115</span>                                            <a class="code hl_class" href="classipc_1_1transport_1_1Mqs__channel.html">transport::Mqs_channel&lt;true, Persistent_mq_handle_from_cfg&gt;</a>&gt;,</div>
<div class="line"><a id="l00116" name="l00116"></a><span class="lineno">  116</span>                                         std::conditional_t</div>
<div class="line"><a id="l00117" name="l00117"></a><span class="lineno">  117</span>                                           &lt;S_TRANSMIT_NATIVE_HANDLES,</div>
<div class="line"><a id="l00118" name="l00118"></a><span class="lineno">  118</span>                                            <a class="code hl_class" href="classipc_1_1transport_1_1Socket__stream__channel.html">transport::Socket_stream_channel&lt;true&gt;</a>,</div>
<div class="line"><a id="l00119" name="l00119"></a><span class="lineno">  119</span>                                            <a class="code hl_class" href="classipc_1_1transport_1_1Socket__stream__channel__of__blobs.html">transport::Socket_stream_channel_of_blobs&lt;true&gt;</a>&gt;&gt;;</div>
<div class="line"><a id="l00120" name="l00120"></a><span class="lineno">  120</span><span class="comment"></span> </div>
<div class="line"><a id="l00121" name="l00121"></a><span class="lineno">  121</span><span class="comment">  /// See Session_mv.  Note: If changed from `vector` please update those doc headers too.</span></div>
<div class="line"><a id="l00122" name="l00122"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a638232ef74a0eb80aeb4f027ee06f9bf">  122</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a638232ef74a0eb80aeb4f027ee06f9bf">Channels</a> = std::vector&lt;Channel_obj&gt;;</div>
<div class="line"><a id="l00123" name="l00123"></a><span class="lineno">  123</span><span class="comment"></span> </div>
<div class="line"><a id="l00124" name="l00124"></a><span class="lineno">  124</span><span class="comment">  /// See Session_mv (or Session concept).</span></div>
<div class="line"><a id="l00125" name="l00125"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a35234981ca87cc2f6b118b3e52452ea8">  125</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a35234981ca87cc2f6b118b3e52452ea8">Mdt_payload_obj</a> = Mdt_payload;</div>
<div class="line"><a id="l00126" name="l00126"></a><span class="lineno">  126</span><span class="comment"></span> </div>
<div class="line"><a id="l00127" name="l00127"></a><span class="lineno">  127</span><span class="comment">  /// See Session_mv (or Session concept).</span></div>
<div class="line"><a id="l00128" name="l00128"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#ace4dab42adec6354cc66081dd218ac71">  128</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#ace4dab42adec6354cc66081dd218ac71">Mdt_reader_ptr</a></div>
<div class="line"><a id="l00129" name="l00129"></a><span class="lineno">  129</span>    = <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">boost::shared_ptr&lt;typename transport::struc::schema::Metadata&lt;Mdt_payload_obj&gt;::Reader</a>&gt;;</div>
<div class="line"><a id="l00130" name="l00130"></a><span class="lineno">  130</span><span class="comment"></span> </div>
<div class="line"><a id="l00131" name="l00131"></a><span class="lineno">  131</span><span class="comment">  /// See Session_mv (or Session concept).</span></div>
<div class="line"><a id="l00132" name="l00132"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a7d68bbb8c0c09983619d563bca30bd45">  132</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a7d68bbb8c0c09983619d563bca30bd45">Mdt_builder</a></div>
<div class="line"><a id="l00133" name="l00133"></a><span class="lineno">  133</span>    = <span class="keyword">typename</span> <a class="code hl_typedef" href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#abfde278018c84aa1542475e9a4089c29">transport::struc::schema::Metadata&lt;Mdt_payload_obj&gt;::Builder</a>;</div>
<div class="line"><a id="l00134" name="l00134"></a><span class="lineno">  134</span><span class="comment"></span> </div>
<div class="line"><a id="l00135" name="l00135"></a><span class="lineno">  135</span><span class="comment">  /// See Session_mv (or Session concept).</span></div>
<div class="line"><a id="l00136" name="l00136"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a4a7a5b83f6ba8bd505685636eabc012b">  136</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a4a7a5b83f6ba8bd505685636eabc012b">Mdt_builder_ptr</a> = boost::shared_ptr&lt;Mdt_builder&gt;;</div>
<div class="line"><a id="l00137" name="l00137"></a><span class="lineno">  137</span><span class="comment"></span> </div>
<div class="line"><a id="l00138" name="l00138"></a><span class="lineno">  138</span><span class="comment">  /// See Session_mv (or Session concept).</span></div>
<div class="line"><a id="l00139" name="l00139"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#aee0db48505c84d3553b7110a9a815036">  139</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">Structured_msg_builder_config</a> = <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">transport::struc::Heap_fixed_builder::Config</a>;</div>
<div class="line"><a id="l00140" name="l00140"></a><span class="lineno">  140</span><span class="comment"></span> </div>
<div class="line"><a id="l00141" name="l00141"></a><span class="lineno">  141</span><span class="comment">  /// See Session_mv (or Session concept).</span></div>
<div class="line"><a id="l00142" name="l00142"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#abd854f2b9316361ef18f15610c242d4b">  142</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">Structured_msg_reader_config</a> = <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">transport::struc::Heap_reader::Config</a>;</div>
<div class="line"><a id="l00143" name="l00143"></a><span class="lineno">  143</span> </div>
<div class="line"><a id="l00144" name="l00144"></a><span class="lineno">  144</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00145" name="l00145"></a><span class="lineno">  145</span><span class="comment"></span> </div>
<div class="line"><a id="l00146" name="l00146"></a><span class="lineno">  146</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00147" name="l00147"></a><span class="lineno">  147</span><span class="comment">   * See Server_session_impl, Client_session_impl.  However in Session_base this value may be not-yet-set (empty), or</span></div>
<div class="line"><a id="l00148" name="l00148"></a><span class="lineno">  148</span><span class="comment">   * set (and immutable from then on).</span></div>
<div class="line"><a id="l00149" name="l00149"></a><span class="lineno">  149</span><span class="comment">   *</span></div>
<div class="line"><a id="l00150" name="l00150"></a><span class="lineno">  150</span><span class="comment">   * This value shall be known and immutable from construction for Server_session_impl, since server namespace -- PID</span></div>
<div class="line"><a id="l00151" name="l00151"></a><span class="lineno">  151</span><span class="comment">   * as of this writing -- can be determined from the start on the server side and applies to every server session</span></div>
<div class="line"><a id="l00152" name="l00152"></a><span class="lineno">  152</span><span class="comment">   * that Session_server produces.  Client_session_impl, however, determines</span></div>
<div class="line"><a id="l00153" name="l00153"></a><span class="lineno">  153</span><span class="comment">   * it at the latest possible moment which is at Client_session_impl::async_connect() time, at which point it needs</span></div>
<div class="line"><a id="l00154" name="l00154"></a><span class="lineno">  154</span><span class="comment">   * to determine the PID via PID file.</span></div>
<div class="line"><a id="l00155" name="l00155"></a><span class="lineno">  155</span><span class="comment">   *</span></div>
<div class="line"><a id="l00156" name="l00156"></a><span class="lineno">  156</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00157" name="l00157"></a><span class="lineno">  157</span><span class="comment">   */</span></div>
<div class="line"><a id="l00158" name="l00158"></a><span class="lineno">  158</span>  <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a4d1327608d6067ed6690bd4efa323c6f">srv_namespace</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00159" name="l00159"></a><span class="lineno">  159</span><span class="comment"></span> </div>
<div class="line"><a id="l00160" name="l00160"></a><span class="lineno">  160</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00161" name="l00161"></a><span class="lineno">  161</span><span class="comment">   * See Server_session_impl, Client_session_impl.  However in Session_base this value may be not-yet-set (empty), or</span></div>
<div class="line"><a id="l00162" name="l00162"></a><span class="lineno">  162</span><span class="comment">   * set (and immutable from then on).</span></div>
<div class="line"><a id="l00163" name="l00163"></a><span class="lineno">  163</span><span class="comment">   *</span></div>
<div class="line"><a id="l00164" name="l00164"></a><span class="lineno">  164</span><span class="comment">   * This value shall be generated uniquely (within some context) for each new `Server_session` produced by</span></div>
<div class="line"><a id="l00165" name="l00165"></a><span class="lineno">  165</span><span class="comment">   * Session_server; and Client_session_impl shall find that out while logging in (last part of entering PEER</span></div>
<div class="line"><a id="l00166" name="l00166"></a><span class="lineno">  166</span><span class="comment">   * state).</span></div>
<div class="line"><a id="l00167" name="l00167"></a><span class="lineno">  167</span><span class="comment">   *</span></div>
<div class="line"><a id="l00168" name="l00168"></a><span class="lineno">  168</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00169" name="l00169"></a><span class="lineno">  169</span><span class="comment">   */</span></div>
<div class="line"><a id="l00170" name="l00170"></a><span class="lineno">  170</span>  <span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#abd1e814b3b640f4bdaa2553352405f26">cli_namespace</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00171" name="l00171"></a><span class="lineno">  171</span><span class="comment"></span> </div>
<div class="line"><a id="l00172" name="l00172"></a><span class="lineno">  172</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00173" name="l00173"></a><span class="lineno">  173</span><span class="comment">   * See Server_session_impl, Client_session_impl.  However in Session_base this value may be not-yet-set (null), or set</span></div>
<div class="line"><a id="l00174" name="l00174"></a><span class="lineno">  174</span><span class="comment">   * (and immutable from then on).  Note the value to which we refer is the actual pointer.  (The Client_app that</span></div>
<div class="line"><a id="l00175" name="l00175"></a><span class="lineno">  175</span><span class="comment">   * is pointed-to, itself, is certainly immutable too.)</span></div>
<div class="line"><a id="l00176" name="l00176"></a><span class="lineno">  176</span><span class="comment">   *</span></div>
<div class="line"><a id="l00177" name="l00177"></a><span class="lineno">  177</span><span class="comment">   * This value shall be set from the start in a Client_session_impl but determined during a given Server_session_impl&#39;s</span></div>
<div class="line"><a id="l00178" name="l00178"></a><span class="lineno">  178</span><span class="comment">   * log-in (the opposing Client_session_impl will transmit the Client_app::m_name).  The log-in shall complete the</span></div>
<div class="line"><a id="l00179" name="l00179"></a><span class="lineno">  179</span><span class="comment">   * `Server_session`&#39;s entry to PEER state.</span></div>
<div class="line"><a id="l00180" name="l00180"></a><span class="lineno">  180</span><span class="comment">   *</span></div>
<div class="line"><a id="l00181" name="l00181"></a><span class="lineno">  181</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00182" name="l00182"></a><span class="lineno">  182</span><span class="comment">   */</span></div>
<div class="line"><a id="l00183" name="l00183"></a><span class="lineno">  183</span>  <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>* <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a3ebdafe7e70719e6d12dd0b15ae85106">cli_app_ptr</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00184" name="l00184"></a><span class="lineno">  184</span><span class="comment"></span> </div>
<div class="line"><a id="l00185" name="l00185"></a><span class="lineno">  185</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00186" name="l00186"></a><span class="lineno">  186</span><span class="comment">   * Computes the name of the interprocess named-mutex used to control reading/writing to the file</span></div>
<div class="line"><a id="l00187" name="l00187"></a><span class="lineno">  187</span><span class="comment">   * storing (written by server, read by client) the value for srv_namespace().  The file</span></div>
<div class="line"><a id="l00188" name="l00188"></a><span class="lineno">  188</span><span class="comment">   * is located as cur_ns_store_absolute_path().</span></div>
<div class="line"><a id="l00189" name="l00189"></a><span class="lineno">  189</span><span class="comment">   *</span></div>
<div class="line"><a id="l00190" name="l00190"></a><span class="lineno">  190</span><span class="comment">   * This may be called anytime.</span></div>
<div class="line"><a id="l00191" name="l00191"></a><span class="lineno">  191</span><span class="comment">   *</span></div>
<div class="line"><a id="l00192" name="l00192"></a><span class="lineno">  192</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00193" name="l00193"></a><span class="lineno">  193</span><span class="comment">   */</span></div>
<div class="line"><a id="l00194" name="l00194"></a><span class="lineno">  194</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a09cbe99083616bae00928f8e37c8373b">cur_ns_store_mutex_absolute_name</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00195" name="l00195"></a><span class="lineno">  195</span><span class="comment"></span> </div>
<div class="line"><a id="l00196" name="l00196"></a><span class="lineno">  196</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00197" name="l00197"></a><span class="lineno">  197</span><span class="comment">   * Computes the absolute path to file storing (written by server, read by client) the value for srv_namespace().</span></div>
<div class="line"><a id="l00198" name="l00198"></a><span class="lineno">  198</span><span class="comment">   * The file is located as cur_ns_store_absolute_path().</span></div>
<div class="line"><a id="l00199" name="l00199"></a><span class="lineno">  199</span><span class="comment">   *</span></div>
<div class="line"><a id="l00200" name="l00200"></a><span class="lineno">  200</span><span class="comment">   * This may be called anytime.</span></div>
<div class="line"><a id="l00201" name="l00201"></a><span class="lineno">  201</span><span class="comment">   *</span></div>
<div class="line"><a id="l00202" name="l00202"></a><span class="lineno">  202</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00203" name="l00203"></a><span class="lineno">  203</span><span class="comment">   */</span></div>
<div class="line"><a id="l00204" name="l00204"></a><span class="lineno">  204</span>  fs::path <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#af059faab56cdf384873f9f2aba8f79cf">cur_ns_store_absolute_path</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00205" name="l00205"></a><span class="lineno">  205</span><span class="comment"></span> </div>
<div class="line"><a id="l00206" name="l00206"></a><span class="lineno">  206</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00207" name="l00207"></a><span class="lineno">  207</span><span class="comment">   * Computes the absolute name at which the server shall set up a transport::Native_socket_stream_acceptor</span></div>
<div class="line"><a id="l00208" name="l00208"></a><span class="lineno">  208</span><span class="comment">   * to which client shall transport::Native_socket_stream::sync_connect() in order to establish a PEER-state</span></div>
<div class="line"><a id="l00209" name="l00209"></a><span class="lineno">  209</span><span class="comment">   * session.</span></div>
<div class="line"><a id="l00210" name="l00210"></a><span class="lineno">  210</span><span class="comment">   *</span></div>
<div class="line"><a id="l00211" name="l00211"></a><span class="lineno">  211</span><span class="comment">   * This must be called no earlier than set_srv_namespace(); otherwise behavior undefined (assertion</span></div>
<div class="line"><a id="l00212" name="l00212"></a><span class="lineno">  212</span><span class="comment">   * may trip).</span></div>
<div class="line"><a id="l00213" name="l00213"></a><span class="lineno">  213</span><span class="comment">   *</span></div>
<div class="line"><a id="l00214" name="l00214"></a><span class="lineno">  214</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00215" name="l00215"></a><span class="lineno">  215</span><span class="comment">   */</span></div>
<div class="line"><a id="l00216" name="l00216"></a><span class="lineno">  216</span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a3d34c5a9c283a6b7c8ab943f344cdd28">session_master_socket_stream_acceptor_absolute_name</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00217" name="l00217"></a><span class="lineno">  217</span><span class="comment"></span> </div>
<div class="line"><a id="l00218" name="l00218"></a><span class="lineno">  218</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00219" name="l00219"></a><span class="lineno">  219</span><span class="comment">   * See Session_mv::heap_fixed_builder_config() (1-arg).</span></div>
<div class="line"><a id="l00220" name="l00220"></a><span class="lineno">  220</span><span class="comment">   *</span></div>
<div class="line"><a id="l00221" name="l00221"></a><span class="lineno">  221</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00222" name="l00222"></a><span class="lineno">  222</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00223" name="l00223"></a><span class="lineno">  223</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00224" name="l00224"></a><span class="lineno">  224</span><span class="comment">   */</span></div>
<div class="line"><a id="l00225" name="l00225"></a><span class="lineno">  225</span>  <span class="keyword">static</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">Structured_msg_builder_config</a> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a08b3d69a6707dcbb233076b7a48de285">heap_fixed_builder_config</a>(flow::log::Logger* logger_ptr);</div>
<div class="line"><a id="l00226" name="l00226"></a><span class="lineno">  226</span><span class="comment"></span> </div>
<div class="line"><a id="l00227" name="l00227"></a><span class="lineno">  227</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00228" name="l00228"></a><span class="lineno">  228</span><span class="comment">   * See Session_mv::heap_reader_config() (1-arg).</span></div>
<div class="line"><a id="l00229" name="l00229"></a><span class="lineno">  229</span><span class="comment">   *</span></div>
<div class="line"><a id="l00230" name="l00230"></a><span class="lineno">  230</span><span class="comment">   * @param logger_ptr</span></div>
<div class="line"><a id="l00231" name="l00231"></a><span class="lineno">  231</span><span class="comment">   *        See above.</span></div>
<div class="line"><a id="l00232" name="l00232"></a><span class="lineno">  232</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00233" name="l00233"></a><span class="lineno">  233</span><span class="comment">   */</span></div>
<div class="line"><a id="l00234" name="l00234"></a><span class="lineno">  234</span>  <span class="keyword">static</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">Structured_msg_reader_config</a> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a489bb6ec7726e39e78dcd4dd2fe3de75">heap_reader_config</a>(flow::log::Logger* logger_ptr);</div>
<div class="line"><a id="l00235" name="l00235"></a><span class="lineno">  235</span> </div>
<div class="line"><a id="l00236" name="l00236"></a><span class="lineno">  236</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00237" name="l00237"></a><span class="lineno">  237</span><span class="comment"></span> </div>
<div class="line"><a id="l00238" name="l00238"></a><span class="lineno">  238</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00239" name="l00239"></a><span class="lineno">  239</span><span class="comment">   * Reference to Server_app (referring to local process in Server_session_impl, opposing process in</span></div>
<div class="line"><a id="l00240" name="l00240"></a><span class="lineno">  240</span><span class="comment">   * Client_session_impl).</span></div>
<div class="line"><a id="l00241" name="l00241"></a><span class="lineno">  241</span><span class="comment">   * This is known from construction and immutable (both the reference, of course, and the Server_app itself).</span></div>
<div class="line"><a id="l00242" name="l00242"></a><span class="lineno">  242</span><span class="comment">   */</span></div>
<div class="line"><a id="l00243" name="l00243"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#afd32d90b86d699263a0f02637dd7c6c6">  243</a></span>  <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#afd32d90b86d699263a0f02637dd7c6c6">m_srv_app_ref</a>;</div>
<div class="line"><a id="l00244" name="l00244"></a><span class="lineno">  244</span> </div>
<div class="line"><a id="l00245" name="l00245"></a><span class="lineno">  245</span><span class="keyword">protected</span>:</div>
<div class="line"><a id="l00246" name="l00246"></a><span class="lineno">  246</span>  <span class="comment">// Constants.</span></div>
<div class="line"><a id="l00247" name="l00247"></a><span class="lineno">  247</span><span class="comment"></span> </div>
<div class="line"><a id="l00248" name="l00248"></a><span class="lineno">  248</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00249" name="l00249"></a><span class="lineno">  249</span><span class="comment">   * Internal timeout for `open_channel()`.</span></div>
<div class="line"><a id="l00250" name="l00250"></a><span class="lineno">  250</span><span class="comment">   *</span></div>
<div class="line"><a id="l00251" name="l00251"></a><span class="lineno">  251</span><span class="comment">   * ### The value ###</span></div>
<div class="line"><a id="l00252" name="l00252"></a><span class="lineno">  252</span><span class="comment">   * We initially tried something much less generous, 500ms.  It worked fine, but some people encountered</span></div>
<div class="line"><a id="l00253" name="l00253"></a><span class="lineno">  253</span><span class="comment">   * the timeout due to unrelated reasons, and it was natural to blame it on the timeout.  This much longer</span></div>
<div class="line"><a id="l00254" name="l00254"></a><span class="lineno">  254</span><span class="comment">   * timeout should make it obvious, in such a situation, that it&#39;s not about some slowness inside Flow-IPC</span></div>
<div class="line"><a id="l00255" name="l00255"></a><span class="lineno">  255</span><span class="comment">   * but a pathological application problem -- particularly around session-open time.  For example not</span></div>
<div class="line"><a id="l00256" name="l00256"></a><span class="lineno">  256</span><span class="comment">   * calling Server_session_impl::init_handlers(), or calling it late, as of this writing can cause issues with this.</span></div>
<div class="line"><a id="l00257" name="l00257"></a><span class="lineno">  257</span><span class="comment">   *</span></div>
<div class="line"><a id="l00258" name="l00258"></a><span class="lineno">  258</span><span class="comment">   * The downside is it makes Session::open_channel() potentially blocking formally speaking, whereas 500ms</span></div>
<div class="line"><a id="l00259" name="l00259"></a><span class="lineno">  259</span><span class="comment">   * could still claim to be non-blocking.  It&#39;s a matter of perspective really.  This value just seems to</span></div>
<div class="line"><a id="l00260" name="l00260"></a><span class="lineno">  260</span><span class="comment">   * cause less confusion.  We might reconsider the whole thing however.</span></div>
<div class="line"><a id="l00261" name="l00261"></a><span class="lineno">  261</span><span class="comment">   */</span></div>
<div class="line"><a id="l00262" name="l00262"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#ae68b7b80ff82ba5cde28a53fa52a5095">  262</a></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <a class="code hl_typedef" href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">util::Fine_duration</a> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#ae68b7b80ff82ba5cde28a53fa52a5095">S_OPEN_CHANNEL_TIMEOUT</a> = boost::chrono::seconds(60);</div>
<div class="line"><a id="l00263" name="l00263"></a><span class="lineno">  263</span><span class="comment"></span> </div>
<div class="line"><a id="l00264" name="l00264"></a><span class="lineno">  264</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00265" name="l00265"></a><span class="lineno">  265</span><span class="comment">   * The max sendable MQ message size as decided by Server_session_impl::make_channel_mqs() (and imposed on both sides,</span></div>
<div class="line"><a id="l00266" name="l00266"></a><span class="lineno">  266</span><span class="comment">   * both directions), if #S_MQS_ENABLED *and* Server_session_impl::S_SHM_ENABLED is `false`, when a channel is opened</span></div>
<div class="line"><a id="l00267" name="l00267"></a><span class="lineno">  267</span><span class="comment">   * (regardless of which side did the active-open or requested pre-opening at session start).</span></div>
<div class="line"><a id="l00268" name="l00268"></a><span class="lineno">  268</span><span class="comment">   * If `*this` belongs to Server_session_impl, that&#39;s what this is.</span></div>
<div class="line"><a id="l00269" name="l00269"></a><span class="lineno">  269</span><span class="comment">   * If it belongs to Client_session_impl, then this is what the opposing process -- if they&#39;re using the same code! --</span></div>
<div class="line"><a id="l00270" name="l00270"></a><span class="lineno">  270</span><span class="comment">   * will have decided.</span></div>
<div class="line"><a id="l00271" name="l00271"></a><span class="lineno">  271</span><span class="comment">   *</span></div>
<div class="line"><a id="l00272" name="l00272"></a><span class="lineno">  272</span><span class="comment">   * Our own heap_fixed_builder_config(), forwarded to Session_mv::heap_fixed_builder_config(), similarly uses</span></div>
<div class="line"><a id="l00273" name="l00273"></a><span class="lineno">  273</span><span class="comment">   * this constant in a matching way.</span></div>
<div class="line"><a id="l00274" name="l00274"></a><span class="lineno">  274</span><span class="comment">   *</span></div>
<div class="line"><a id="l00275" name="l00275"></a><span class="lineno">  275</span><span class="comment">   * @note If Server_session_impl::S_SHM_ENABLED is `true`, then a different (much smaller) MQ message size limit</span></div>
<div class="line"><a id="l00276" name="l00276"></a><span class="lineno">  276</span><span class="comment">   *       is configured.  In that case, also, heap_fixed_builder_config() is not relevant and should not be used.</span></div>
<div class="line"><a id="l00277" name="l00277"></a><span class="lineno">  277</span><span class="comment">   *</span></div>
<div class="line"><a id="l00278" name="l00278"></a><span class="lineno">  278</span><span class="comment">   * While it looks simple, there is a number of subtleties one must understand if *ever* considering changing it.</span></div>
<div class="line"><a id="l00279" name="l00279"></a><span class="lineno">  279</span><span class="comment">   *</span></div>
<div class="line"><a id="l00280" name="l00280"></a><span class="lineno">  280</span><span class="comment">   * ### bipc versus POSIX MQs ###</span></div>
<div class="line"><a id="l00281" name="l00281"></a><span class="lineno">  281</span><span class="comment">   * As of this writing the same constant value is used for both types of MQ configurable.  The actual value is</span></div>
<div class="line"><a id="l00282" name="l00282"></a><span class="lineno">  282</span><span class="comment">   * chosen due to a certain aspect of POSIX MQs (discussed just below); and we reuse it for bipc, though we absolutely</span></div>
<div class="line"><a id="l00283" name="l00283"></a><span class="lineno">  283</span><span class="comment">   * do not have to, for simplicity/for lack of better ideas at the moment.  It would be possible to bifurcate those</span></div>
<div class="line"><a id="l00284" name="l00284"></a><span class="lineno">  284</span><span class="comment">   * two cases if really desired.</span></div>
<div class="line"><a id="l00285" name="l00285"></a><span class="lineno">  285</span><span class="comment">   *</span></div>
<div class="line"><a id="l00286" name="l00286"></a><span class="lineno">  286</span><span class="comment">   * ### Why 8Ki? ###</span></div>
<div class="line"><a id="l00287" name="l00287"></a><span class="lineno">  287</span><span class="comment">   * By default in Linux POSIX MQs this happens to be the actual limit for # of unread messages --</span></div>
<div class="line"><a id="l00288" name="l00288"></a><span class="lineno">  288</span><span class="comment">   * visible in /proc/sys/fs/mqueue/msgsize_max -- so we cannot go higher typically.  However that file can be modified.</span></div>
<div class="line"><a id="l00289" name="l00289"></a><span class="lineno">  289</span><span class="comment">   * For now we assume a typical environment; or at least that it will not go *below* this typical default.</span></div>
<div class="line"><a id="l00290" name="l00290"></a><span class="lineno">  290</span><span class="comment">   * If did try a higher number here, opening of MQs by server will likely emit an error and refuse</span></div>
<div class="line"><a id="l00291" name="l00291"></a><span class="lineno">  291</span><span class="comment">   * (Server_session_impl::make_channel_mqs()).</span></div>
<div class="line"><a id="l00292" name="l00292"></a><span class="lineno">  292</span><span class="comment">   *</span></div>
<div class="line"><a id="l00293" name="l00293"></a><span class="lineno">  293</span><span class="comment">   * ### Things to consider if changing the value away from the above ###</span></div>
<div class="line"><a id="l00294" name="l00294"></a><span class="lineno">  294</span><span class="comment">   * - Contemplate why you&#39;re doing it.  bipc MQs are seen (in Boost source) to be a simple zero-copy data structure</span></div>
<div class="line"><a id="l00295" name="l00295"></a><span class="lineno">  295</span><span class="comment">   *   in an internally maintained kernel-persistent SHM pool; while I (ygoldfel) haven&#39;t verified via kernal source,</span></div>
<div class="line"><a id="l00296" name="l00296"></a><span class="lineno">  296</span><span class="comment">   *   likely Linux POSIX MQ impl is something very similar (reasoning omitted but trust me).  So copy perf should</span></div>
<div class="line"><a id="l00297" name="l00297"></a><span class="lineno">  297</span><span class="comment">   *   not be a factor; only RAM use and the functional ability to transmit messages of a certain size.</span></div>
<div class="line"><a id="l00298" name="l00298"></a><span class="lineno">  298</span><span class="comment">   *   - If the plan is to use `transport::struc::Heap_fixed_builder`-backed for structured messages</span></div>
<div class="line"><a id="l00299" name="l00299"></a><span class="lineno">  299</span><span class="comment">   *     (via transport::struc::Channel), then the max size is quite important: if a *leaf* in your message exceeds</span></div>
<div class="line"><a id="l00300" name="l00300"></a><span class="lineno">  300</span><span class="comment">   *     this size when serialized, it is a fatal error.</span></div>
<div class="line"><a id="l00301" name="l00301"></a><span class="lineno">  301</span><span class="comment">   *   - If, however, the plan is to use SHM-backing (e.g., via `shm::classic::*_session`), then this constant</span></div>
<div class="line"><a id="l00302" name="l00302"></a><span class="lineno">  302</span><span class="comment">   *     does not get used (a much smaller value does -- so small it would be ~meaningless to decrease it).</span></div>
<div class="line"><a id="l00303" name="l00303"></a><span class="lineno">  303</span><span class="comment">   * - Suppose you have changed this value, and suppose the `Heap_fixed_builder`-based use case *does* matter.</span></div>
<div class="line"><a id="l00304" name="l00304"></a><span class="lineno">  304</span><span class="comment">   *   If ::ipc has not yet been released in production, ever, then it&#39;s fine (assuming, that is, it&#39;ll work</span></div>
<div class="line"><a id="l00305" name="l00305"></a><span class="lineno">  305</span><span class="comment">   *   in the first place given the aforementioned `/proc/sys/...` limit for POSIX MQs).  If it *has* been</span></div>
<div class="line"><a id="l00306" name="l00306"></a><span class="lineno">  306</span><span class="comment">   *   released then there is an annoying subtlety to consider:</span></div>
<div class="line"><a id="l00307" name="l00307"></a><span class="lineno">  307</span><span class="comment">   *   - If you can guarantee (via release process) that the client and server will always use the same ::ipc software,</span></div>
<div class="line"><a id="l00308" name="l00308"></a><span class="lineno">  308</span><span class="comment">   *     then you&#39;re still fine.  Just change this value; done.  Otherwise though:</span></div>
<div class="line"><a id="l00309" name="l00309"></a><span class="lineno">  309</span><span class="comment">   *   - There&#39;s the unfortunate caveat that is Session_base::heap_fixed_builder_config().  There you will note</span></div>
<div class="line"><a id="l00310" name="l00310"></a><span class="lineno">  310</span><span class="comment">   *     it says that the *server* decides (for both sides) what this value is.  In that case that method</span></div>
<div class="line"><a id="l00311" name="l00311"></a><span class="lineno">  311</span><span class="comment">   *     will be correct in the server process; but if the client process is speaking to a different version</span></div>
<div class="line"><a id="l00312" name="l00312"></a><span class="lineno">  312</span><span class="comment">   *     of the server, with a different value for #S_MQS_MAX_MSG_SZ, then that is a potential bug.</span></div>
<div class="line"><a id="l00313" name="l00313"></a><span class="lineno">  313</span><span class="comment">   *     - Therefore it would be advisable to not mess with it (again... once a production version is out there).</span></div>
<div class="line"><a id="l00314" name="l00314"></a><span class="lineno">  314</span><span class="comment">   *       If you *do* mess with it, there are ways to ensure it all works out anyway: logic could be added</span></div>
<div class="line"><a id="l00315" name="l00315"></a><span class="lineno">  315</span><span class="comment">   *       wherein the client specifies its own #S_MQS_MAX_MSG_SZ when issuing an open-channel request,</span></div>
<div class="line"><a id="l00316" name="l00316"></a><span class="lineno">  316</span><span class="comment">   *       and the server must honor it in its Server_session_impl::make_channel_mqs().  So it can be done --</span></div>
<div class="line"><a id="l00317" name="l00317"></a><span class="lineno">  317</span><span class="comment">   *       just know that in that case you&#39;ll have to actually add such logic; or somewhat break</span></div>
<div class="line"><a id="l00318" name="l00318"></a><span class="lineno">  318</span><span class="comment">   *       heap_fixed_builder_config().  The reason I (ygoldfel) have not done this already is it seems unlikely</span></div>
<div class="line"><a id="l00319" name="l00319"></a><span class="lineno">  319</span><span class="comment">   *       (for various reasons listed above) that tweaking this value is of much practical value.</span></div>
<div class="line"><a id="l00320" name="l00320"></a><span class="lineno">  320</span><span class="comment">   */</span></div>
<div class="line"><a id="l00321" name="l00321"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#af0b52934c6b1204cb3ba676480727d27">  321</a></span>  <span class="keyword">static</span> <span class="keyword">constexpr</span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#af0b52934c6b1204cb3ba676480727d27">S_MQS_MAX_MSG_SZ</a> = 8 * 1024;</div>
<div class="line"><a id="l00322" name="l00322"></a><span class="lineno">  322</span> </div>
<div class="line"><a id="l00323" name="l00323"></a><span class="lineno">  323</span>  <span class="comment">// Types.</span></div>
<div class="line"><a id="l00324" name="l00324"></a><span class="lineno">  324</span><span class="comment"></span> </div>
<div class="line"><a id="l00325" name="l00325"></a><span class="lineno">  325</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00326" name="l00326"></a><span class="lineno">  326</span><span class="comment">   * The (internally used) session master channel is a transport::struc::Channel of this concrete type.</span></div>
<div class="line"><a id="l00327" name="l00327"></a><span class="lineno">  327</span><span class="comment">   *</span></div>
<div class="line"><a id="l00328" name="l00328"></a><span class="lineno">  328</span><span class="comment">   * Rationale for the chosen knob values:</span></div>
<div class="line"><a id="l00329" name="l00329"></a><span class="lineno">  329</span><span class="comment">   *   - To be able to open_channel() (and hence passive-open) a #Channel_obj that can transmit native handles,</span></div>
<div class="line"><a id="l00330" name="l00330"></a><span class="lineno">  330</span><span class="comment">   *     certainly a handles pipe is required to transmit half of each socket-pair.  That said, an `Mqs_channel`</span></div>
<div class="line"><a id="l00331" name="l00331"></a><span class="lineno">  331</span><span class="comment">   *     would work fine if #S_SOCKET_STREAM_ENABLED is `false`.  The real reason at least a handles pipe is</span></div>
<div class="line"><a id="l00332" name="l00332"></a><span class="lineno">  332</span><span class="comment">   *     required is that to establish this channel -- unlike subsequent channels in the session -- a client-server</span></div>
<div class="line"><a id="l00333" name="l00333"></a><span class="lineno">  333</span><span class="comment">   *     flow is required.  This connection establishment is not possible with MQs, so of the available options</span></div>
<div class="line"><a id="l00334" name="l00334"></a><span class="lineno">  334</span><span class="comment">   *     only a socket stream would work.</span></div>
<div class="line"><a id="l00335" name="l00335"></a><span class="lineno">  335</span><span class="comment">   *     - There is no bulky data transfers over this channel, so adding</span></div>
<div class="line"><a id="l00336" name="l00336"></a><span class="lineno">  336</span><span class="comment">   *       a parallel MQ-based blobs pipe is overkill even if it could help performance; more so since the</span></div>
<div class="line"><a id="l00337" name="l00337"></a><span class="lineno">  337</span><span class="comment">   *       master channel is unlikely to be used frequently (open_channel() on either side shouldn&#39;t be that frequent).</span></div>
<div class="line"><a id="l00338" name="l00338"></a><span class="lineno">  338</span><span class="comment">   *       Since, again, the minute differences in perf versus a Unix-domain-socket-based transport are unlikely to</span></div>
<div class="line"><a id="l00339" name="l00339"></a><span class="lineno">  339</span><span class="comment">   *       be significant in this use case, it is easier to use a socket stream which lacks any kernel-persistent</span></div>
<div class="line"><a id="l00340" name="l00340"></a><span class="lineno">  340</span><span class="comment">   *       cleanup considerations -- or even just distinct naming considerations for that matter.</span></div>
<div class="line"><a id="l00341" name="l00341"></a><span class="lineno">  341</span><span class="comment">   *     - So: use a transport::Socket_stream_channel.</span></div>
<div class="line"><a id="l00342" name="l00342"></a><span class="lineno">  342</span><span class="comment">   *   - Use the specially tailored (internal) session master channel capnp schema, whose key messages cover (at least):</span></div>
<div class="line"><a id="l00343" name="l00343"></a><span class="lineno">  343</span><span class="comment">   *     - session log-in at the start;</span></div>
<div class="line"><a id="l00344" name="l00344"></a><span class="lineno">  344</span><span class="comment">   *     - open-channel request/response.</span></div>
<div class="line"><a id="l00345" name="l00345"></a><span class="lineno">  345</span><span class="comment">   *   - As of this writing, for serializing/deserializing, it&#39;s either the heap-allocating engine on either side,</span></div>
<div class="line"><a id="l00346" name="l00346"></a><span class="lineno">  346</span><span class="comment">   *     or it&#39;s something SHM-based (which could be faster).  However at least some SHM-based builders/readers</span></div>
<div class="line"><a id="l00347" name="l00347"></a><span class="lineno">  347</span><span class="comment">   *     themselves (internally) require a transport::Channel to function, which would require a Session typically,</span></div>
<div class="line"><a id="l00348" name="l00348"></a><span class="lineno">  348</span><span class="comment">   *     creating a cyclical feature dependency.  Plus, SHM has cleanup considerations.  So a heap-based engine</span></div>
<div class="line"><a id="l00349" name="l00349"></a><span class="lineno">  349</span><span class="comment">   *     on either side is the natural choice.  The cost is some perf: one copies from heap into the session master</span></div>
<div class="line"><a id="l00350" name="l00350"></a><span class="lineno">  350</span><span class="comment">   *     transport; and from there into heap on the other side.  In this context that&#39;s not a significant perf loss.</span></div>
<div class="line"><a id="l00351" name="l00351"></a><span class="lineno">  351</span><span class="comment">   */</span></div>
<div class="line"><a id="l00352" name="l00352"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a26d038e14e3c0e461e76de88c4ce76c5">  352</a></span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Channel.html">Master_structured_channel</a></div>
<div class="line"><a id="l00353" name="l00353"></a><span class="lineno">  353</span>    = <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Channel.html">transport::struc::Channel_via_heap&lt;transport::Socket_stream_channel&lt;true&gt;</a>,</div>
<div class="line"><a id="l00354" name="l00354"></a><span class="lineno">  354</span>                                         schema::detail::SessionMasterChannelMessageBody</div>
<div class="line"><a id="l00355" name="l00355"></a><span class="lineno">  355</span>                                           &lt;<a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a35234981ca87cc2f6b118b3e52452ea8">Mdt_payload_obj</a>&gt;&gt;;</div>
<div class="line"><a id="l00356" name="l00356"></a><span class="lineno">  356</span><span class="comment"></span> </div>
<div class="line"><a id="l00357" name="l00357"></a><span class="lineno">  357</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00358" name="l00358"></a><span class="lineno">  358</span><span class="comment">   * Handle to #Master_structured_channel.</span></div>
<div class="line"><a id="l00359" name="l00359"></a><span class="lineno">  359</span><span class="comment">   *</span></div>
<div class="line"><a id="l00360" name="l00360"></a><span class="lineno">  360</span><span class="comment">   * ### Rationale for type chosen ###</span></div>
<div class="line"><a id="l00361" name="l00361"></a><span class="lineno">  361</span><span class="comment">   * It&#39;s a handle at all, because at first and possibly later there may be no session master channel, so a null</span></div>
<div class="line"><a id="l00362" name="l00362"></a><span class="lineno">  362</span><span class="comment">   * value is useful.  (Though, `std::optional` could be used instead.)  It&#39;s a ref-counted pointer as opposed</span></div>
<div class="line"><a id="l00363" name="l00363"></a><span class="lineno">  363</span><span class="comment">   * to `unique_ptr` so that it can be observed via #Master_structured_channel_observer (`weak_ptr`) which is not</span></div>
<div class="line"><a id="l00364" name="l00364"></a><span class="lineno">  364</span><span class="comment">   * (and cannot) be available for `unique_ptr`.  The observing is needed tactically for certain async lambda needs.</span></div>
<div class="line"><a id="l00365" name="l00365"></a><span class="lineno">  365</span><span class="comment">   */</span></div>
<div class="line"><a id="l00366" name="l00366"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#af0ca2a01d7d0d92038aae56fc1cdd505">  366</a></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#af0ca2a01d7d0d92038aae56fc1cdd505">Master_structured_channel_ptr</a> = boost::shared_ptr&lt;Master_structured_channel&gt;;</div>
<div class="line"><a id="l00367" name="l00367"></a><span class="lineno">  367</span><span class="comment"></span> </div>
<div class="line"><a id="l00368" name="l00368"></a><span class="lineno">  368</span><span class="comment">  /// Observer of #Master_structured_channel_ptr.  See its doc header.</span></div>
<div class="line"><a id="l00369" name="l00369"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#ae2a123b29dd044a638e94d1f294c8f28">  369</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#ae2a123b29dd044a638e94d1f294c8f28">Master_structured_channel_observer</a> = boost::weak_ptr&lt;Master_structured_channel&gt;;</div>
<div class="line"><a id="l00370" name="l00370"></a><span class="lineno">  370</span><span class="comment"></span> </div>
<div class="line"><a id="l00371" name="l00371"></a><span class="lineno">  371</span><span class="comment">  /// Concrete function type for the on-passive-open handler (if any), used for storage.</span></div>
<div class="line"><a id="l00372" name="l00372"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">  372</a></span><span class="comment"></span>  <span class="keyword">using </span><a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">On_passive_open_channel_func</a> = <a class="code hl_typedef" href="namespaceipc.html#aa455c7f045059736578ca275fc1a851f">Function</a>&lt;void (<a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a71f02a809d667c23ff8af29a96940bd1">Channel_obj</a>&amp;&amp; new_channel,</div>
<div class="line"><a id="l00373" name="l00373"></a><span class="lineno">  373</span>                                                      <a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#ace4dab42adec6354cc66081dd218ac71">Mdt_reader_ptr</a>&amp;&amp; new_channel_mdt)&gt;;</div>
<div class="line"><a id="l00374" name="l00374"></a><span class="lineno">  374</span><span class="comment"></span> </div>
<div class="line"><a id="l00375" name="l00375"></a><span class="lineno">  375</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00376" name="l00376"></a><span class="lineno">  376</span><span class="comment">   * Optional to use by subclasses, this operates a simple state machine that carries out a graceful-session-end</span></div>
<div class="line"><a id="l00377" name="l00377"></a><span class="lineno">  377</span><span class="comment">   * handshake procedure.  A particular Client_session_impl and symmetrically its opposing Server_session_impl</span></div>
<div class="line"><a id="l00378" name="l00378"></a><span class="lineno">  378</span><span class="comment">   * shall instantiate a `*this` internally and invoke its methods on certain events, as described in their</span></div>
<div class="line"><a id="l00379" name="l00379"></a><span class="lineno">  379</span><span class="comment">   * contracts.</span></div>
<div class="line"><a id="l00380" name="l00380"></a><span class="lineno">  380</span><span class="comment">   *</span></div>
<div class="line"><a id="l00381" name="l00381"></a><span class="lineno">  381</span><span class="comment">   * Now we explain what we&#39;re solving (Rationale); then how we solve it (Design).  The latter is much simpler,</span></div>
<div class="line"><a id="l00382" name="l00382"></a><span class="lineno">  382</span><span class="comment">   * we think, to understand then the former.  Hence apologies in advance for the length of &quot;Rationale&quot; section.</span></div>
<div class="line"><a id="l00383" name="l00383"></a><span class="lineno">  383</span><span class="comment">   *</span></div>
<div class="line"><a id="l00384" name="l00384"></a><span class="lineno">  384</span><span class="comment">   * ### Rationale ###</span></div>
<div class="line"><a id="l00385" name="l00385"></a><span class="lineno">  385</span><span class="comment">   * Consider a particular Client_session_impl + Server_session_impl class/object pair, A and B.  In this case --</span></div>
<div class="line"><a id="l00386" name="l00386"></a><span class="lineno">  386</span><span class="comment">   * which is somewhat unusual (relative to most internal `Session` algorithms) but in a good, simplifying way --</span></div>
<div class="line"><a id="l00387" name="l00387"></a><span class="lineno">  387</span><span class="comment">   * it does not matter which is A and which is B.  So let&#39;s say A is us and B is the opposing guy.</span></div>
<div class="line"><a id="l00388" name="l00388"></a><span class="lineno">  388</span><span class="comment">   *</span></div>
<div class="line"><a id="l00389" name="l00389"></a><span class="lineno">  389</span><span class="comment">   * Also, for now, assume these are just the vanilla ones: session::Client_session_impl and</span></div>
<div class="line"><a id="l00390" name="l00390"></a><span class="lineno">  390</span><span class="comment">   * session::Server_session_impl; not SHM-enabled -- no SHM arenas in play.</span></div>
<div class="line"><a id="l00391" name="l00391"></a><span class="lineno">  391</span><span class="comment">   *</span></div>
<div class="line"><a id="l00392" name="l00392"></a><span class="lineno">  392</span><span class="comment">   * Consider what happens when A dtor is invoked, in PEER state.  The session ends, and the session-end trigger is us.</span></div>
<div class="line"><a id="l00393" name="l00393"></a><span class="lineno">  393</span><span class="comment">   * Without Graceful_finisher what happens is as follows.  The #Master_structured_channel in `*this` is closed;</span></div>
<div class="line"><a id="l00394" name="l00394"></a><span class="lineno">  394</span><span class="comment">   * and then `*this` goes away altogether right away/synchronously.  Soon B&#39;s #Master_structured_channel</span></div>
<div class="line"><a id="l00395" name="l00395"></a><span class="lineno">  395</span><span class="comment">   * throws the graceful-close error; B itself correctly interprets this as a session-end trigger; and B throws</span></div>
<div class="line"><a id="l00396" name="l00396"></a><span class="lineno">  396</span><span class="comment">   * an error via the `Session` error handler.  Now, the user is told by docs they informally *should* destroy</span></div>
<div class="line"><a id="l00397" name="l00397"></a><span class="lineno">  397</span><span class="comment">   * the B (invoke its dtor) ASAP, but nothing is formally forcing them to; it can sit around.  It will never</span></div>
<div class="line"><a id="l00398" name="l00398"></a><span class="lineno">  398</span><span class="comment">   * accept channel passive-opens; `open_channel()` will no-op / return null; etc.  It is useless, but it can stay</span></div>
<div class="line"><a id="l00399" name="l00399"></a><span class="lineno">  399</span><span class="comment">   * around.  Eventually B dtor will be invoked by user; it&#39;ll basically clean up data structures, and that&#39;s that.</span></div>
<div class="line"><a id="l00400" name="l00400"></a><span class="lineno">  400</span><span class="comment">   *</span></div>
<div class="line"><a id="l00401" name="l00401"></a><span class="lineno">  401</span><span class="comment">   * There is no problem there: A dtor and B dtor can run at quite different times, or more precisely B dtor</span></div>
<div class="line"><a id="l00402" name="l00402"></a><span class="lineno">  402</span><span class="comment">   * can run much later than A dtor which triggered session-end.  Nothing bad happens.</span></div>
<div class="line"><a id="l00403" name="l00403"></a><span class="lineno">  403</span><span class="comment">   *</span></div>
<div class="line"><a id="l00404" name="l00404"></a><span class="lineno">  404</span><span class="comment">   * Now we&#39;ll discuss this in specific terms around actual `Client/Server_session_impl` variants that do exist</span></div>
<div class="line"><a id="l00405" name="l00405"></a><span class="lineno">  405</span><span class="comment">   * at this time.  We could try to be formal and general, but it&#39;s easier to just be specific for exposition</span></div>
<div class="line"><a id="l00406" name="l00406"></a><span class="lineno">  406</span><span class="comment">   * purposes.</span></div>
<div class="line"><a id="l00407" name="l00407"></a><span class="lineno">  407</span><span class="comment">   *</span></div>
<div class="line"><a id="l00408" name="l00408"></a><span class="lineno">  408</span><span class="comment">   * Take, now, the shm::classic::Client_session_impl shm::classic::Server_session_impl variants.  The above</span></div>
<div class="line"><a id="l00409" name="l00409"></a><span class="lineno">  409</span><span class="comment">   * generally holds, but there are now SHM arenas in play.  We can forget about the app-scope arenas right off</span></div>
<div class="line"><a id="l00410" name="l00410"></a><span class="lineno">  410</span><span class="comment">   * the bat: That guy stays around as long as the `Session_server` does, and that guy is formally required</span></div>
<div class="line"><a id="l00411" name="l00411"></a><span class="lineno">  411</span><span class="comment">   * to be around until all child `Session`s have been destroyed.  So only session-scope arenas -- the ones</span></div>
<div class="line"><a id="l00412" name="l00412"></a><span class="lineno">  412</span><span class="comment">   * inside A and B -- are relevant.  In fact, for SHM-classic there really is only *one* arena: A holds a</span></div>
<div class="line"><a id="l00413" name="l00413"></a><span class="lineno">  413</span><span class="comment">   * handle to it (`a.session_shm()` points to it), and B does so symmetrically.</span></div>
<div class="line"><a id="l00414" name="l00414"></a><span class="lineno">  414</span><span class="comment">   *</span></div>
<div class="line"><a id="l00415" name="l00415"></a><span class="lineno">  415</span><span class="comment">   * Now reconsider the scenario above: A dtor runs.  (Insert vanilla `*_session_impl` text from above here.)</span></div>
<div class="line"><a id="l00416" name="l00416"></a><span class="lineno">  416</span><span class="comment">   * Also, though, A dtor will remove the underlying SHM-pool by its name.  (This is possibly a lie.  This is</span></div>
<div class="line"><a id="l00417" name="l00417"></a><span class="lineno">  417</span><span class="comment">   * technically so, only if A is a `Server_session_impl`; we&#39;ve assigned the task to the server side as of this</span></div>
<div class="line"><a id="l00418" name="l00418"></a><span class="lineno">  418</span><span class="comment">   * writing.  But this technicality is irrelevant: unlinking the SHM-pool doesn&#39;t blow up the other side&#39;s</span></div>
<div class="line"><a id="l00419" name="l00419"></a><span class="lineno">  419</span><span class="comment">   * access to the arena; it remains in RAM until that guy closes.  So just bear with us here.)  Then indeed</span></div>
<div class="line"><a id="l00420" name="l00420"></a><span class="lineno">  420</span><span class="comment">   * B dtor can run sometime later.  Is there a problem?  For SHM-classic, which is what we&#39;re discussing, no:</span></div>
<div class="line"><a id="l00421" name="l00421"></a><span class="lineno">  421</span><span class="comment">   * The arena -- 1 shared SHM-pool in this case -- stays alive, until B&#39;s handle gets closed by B dtor.</span></div>
<div class="line"><a id="l00422" name="l00422"></a><span class="lineno">  422</span><span class="comment">   * What about allocations/deallocations?  No problem there either: By contract, the A user *must* drop all</span></div>
<div class="line"><a id="l00423" name="l00423"></a><span class="lineno">  423</span><span class="comment">   * cross-process `shared_ptr` handles to objects that it owns, before invoking A dtor; so A is fine, and the</span></div>
<div class="line"><a id="l00424" name="l00424"></a><span class="lineno">  424</span><span class="comment">   * internal cross-process ref-counts for each A-held object get decremented by 1, due to the `shared_ptr` handles</span></div>
<div class="line"><a id="l00425" name="l00425"></a><span class="lineno">  425</span><span class="comment">   * being nullified by the user by contract.  (For context: The guided manual `session_app_org` page describes</span></div>
<div class="line"><a id="l00426" name="l00426"></a><span class="lineno">  426</span><span class="comment">   * to the reader how to structure their program, so that this is guaranteed.  In short, declare the object</span></div>
<div class="line"><a id="l00427" name="l00427"></a><span class="lineno">  427</span><span class="comment">   * handle data members in their code after the `Session` data member, so they get deinitialized in the reverse</span></div>
<div class="line"><a id="l00428" name="l00428"></a><span class="lineno">  428</span><span class="comment">   * order, in the user&#39;s hypothetical recommended `App_session` class.)  Isn&#39;t there a problem in B, though?  No:</span></div>
<div class="line"><a id="l00429" name="l00429"></a><span class="lineno">  429</span><span class="comment">   * the B user shall drop *its* `shared_ptr` handles, before invoking B dtor; this will drop their internal</span></div>
<div class="line"><a id="l00430" name="l00430"></a><span class="lineno">  430</span><span class="comment">   * cross-process ref-counts to 0; at which point shm::Pool_arena logic will deallocate those objects.  Deallocation</span></div>
<div class="line"><a id="l00431" name="l00431"></a><span class="lineno">  431</span><span class="comment">   * is entirely distributed between A and B; in this scenario B&#39;s handles just happen to live longer and therefore</span></div>
<div class="line"><a id="l00432" name="l00432"></a><span class="lineno">  432</span><span class="comment">   * happen to be the ones triggering the deallocations -- by the B process itself, synchronously.</span></div>
<div class="line"><a id="l00433" name="l00433"></a><span class="lineno">  433</span><span class="comment">   * A is not &quot;in charge&quot; of deallocations of anything in any special way; it doesn&#39;t matter which process originally</span></div>
<div class="line"><a id="l00434" name="l00434"></a><span class="lineno">  434</span><span class="comment">   * allocated a given object either.  That&#39;s the beauty/simplicity of SHM-classic.  (There are of course trade-offs</span></div>
<div class="line"><a id="l00435" name="l00435"></a><span class="lineno">  435</span><span class="comment">   * in play; this is worse for segregation/safety... see Manual and such.)</span></div>
<div class="line"><a id="l00436" name="l00436"></a><span class="lineno">  436</span><span class="comment">   *</span></div>
<div class="line"><a id="l00437" name="l00437"></a><span class="lineno">  437</span><span class="comment">   * Now we come to the point.  Consider session::shm::arena_lend::jemalloc::Client_session_impl and</span></div>
<div class="line"><a id="l00438" name="l00438"></a><span class="lineno">  438</span><span class="comment">   * `Server_session_impl`.  There *is* a problem.  Interestingly this time it really does *not* matter whether</span></div>
<div class="line"><a id="l00439" name="l00439"></a><span class="lineno">  439</span><span class="comment">   * A is server or client-side.  In SHM-jemalloc the session-scope arenas are not 1 but 2:</span></div>
<div class="line"><a id="l00440" name="l00440"></a><span class="lineno">  440</span><span class="comment">   * A has an arena, from which process A can allocate, and in which process A shall deallocate.</span></div>
<div class="line"><a id="l00441" name="l00441"></a><span class="lineno">  441</span><span class="comment">   * B has an arena, from which process B can allocate, and in which process B shall deallocate.</span></div>
<div class="line"><a id="l00442" name="l00442"></a><span class="lineno">  442</span><span class="comment">   * If B borrows object X from A, and is later done with it -- the `shared_ptr` local ref-count reached 0 --</span></div>
<div class="line"><a id="l00443" name="l00443"></a><span class="lineno">  443</span><span class="comment">   * SHM-jemalloc-arranged `shared_ptr` deleter will send an internal message over a special channel to A.</span></div>
<div class="line"><a id="l00444" name="l00444"></a><span class="lineno">  444</span><span class="comment">   * A will deallocate X once that has occurred, *and* any A-held `shared_ptr` group for X has also reached</span></div>
<div class="line"><a id="l00445" name="l00445"></a><span class="lineno">  445</span><span class="comment">   * ref-count 0 (which may have happened before, or it may happen later).  Exactly the same is true of A borrowing</span></div>
<div class="line"><a id="l00446" name="l00446"></a><span class="lineno">  446</span><span class="comment">   * from B, conversely/symmetrically.</span></div>
<div class="line"><a id="l00447" name="l00447"></a><span class="lineno">  447</span><span class="comment">   *</span></div>
<div class="line"><a id="l00448" name="l00448"></a><span class="lineno">  448</span><span class="comment">   * The problem is this: Suppose B holds a borrowed handle X (to an A-allocated object).  Now A dtor runs;</span></div>
<div class="line"><a id="l00449" name="l00449"></a><span class="lineno">  449</span><span class="comment">   * its `.session_shm()` arena -- its constitutent SHM-pools! -- is destroyed.  That in itself shouldn&#39;t be</span></div>
<div class="line"><a id="l00450" name="l00450"></a><span class="lineno">  450</span><span class="comment">   * a problem; again B presumably holds a SHM-pool handle, so it won&#39;t just disappear from RAM under it.</span></div>
<div class="line"><a id="l00451" name="l00451"></a><span class="lineno">  451</span><span class="comment">   * I (ygoldfel) am somewhat fuzzy on what exactly happens (not being the direct author of SHM-jemalloc), but</span></div>
<div class="line"><a id="l00452" name="l00452"></a><span class="lineno">  452</span><span class="comment">   * basically as I understand it, in destroying the arena, a bunch of jemalloc deinit steps execute; perhaps</span></div>
<div class="line"><a id="l00453" name="l00453"></a><span class="lineno">  453</span><span class="comment">   * heap-marker data structures are modified all over the place... it&#39;s chaos.  The bottom line is:</span></div>
<div class="line"><a id="l00454" name="l00454"></a><span class="lineno">  454</span><span class="comment">   * A arena gets mangled, so the B-held borrowed handle X has a high chance of pointing, now, to garbage:</span></div>
<div class="line"><a id="l00455" name="l00455"></a><span class="lineno">  455</span><span class="comment">   * Not unmapped garbage; not into a SHM-pool that&#39;s magically gone -- it&#39;s still there -- so there&#39;s not necessarily</span></div>
<div class="line"><a id="l00456" name="l00456"></a><span class="lineno">  456</span><span class="comment">   * a SEGV as a result; just garbage in the ~sense of accessing `free()`d (not un-`mmap()`ped) memory.</span></div>
<div class="line"><a id="l00457" name="l00457"></a><span class="lineno">  457</span><span class="comment">   *</span></div>
<div class="line"><a id="l00458" name="l00458"></a><span class="lineno">  458</span><span class="comment">   * (Update: I&#39;ve spoken to the SHM-jemalloc author echan, and the above is basically right with a couple</span></div>
<div class="line"><a id="l00459" name="l00459"></a><span class="lineno">  459</span><span class="comment">   * clarifications.  It&#39;s not so much that the arena object being destroyed is the issue; in fact that in itself would</span></div>
<div class="line"><a id="l00460" name="l00460"></a><span class="lineno">  460</span><span class="comment">   * be handled gracefully by SHM-jemalloc innards; they will keep the arena around, even if the outer object goes away</span></div>
<div class="line"><a id="l00461" name="l00461"></a><span class="lineno">  461</span><span class="comment">   * (or more precisely as of this writing the arena-handle -- a `shared_ptr` -- does), while it knows things are</span></div>
<div class="line"><a id="l00462" name="l00462"></a><span class="lineno">  462</span><span class="comment">   * pointing into it, even borrowed things in another process.  Really it&#39;s the fact that we kill the *channel*</span></div>
<div class="line"><a id="l00463" name="l00463"></a><span class="lineno">  463</span><span class="comment">   * it uses to communicate with the borrower process: the arena is told there&#39;s nothing out there pointing into</span></div>
<div class="line"><a id="l00464" name="l00464"></a><span class="lineno">  464</span><span class="comment">   * it: locally the user has to have dropped all constructed-object handles; and the borrower process it no</span></div>
<div class="line"><a id="l00465" name="l00465"></a><span class="lineno">  465</span><span class="comment">   * longer has a way of contacting it; so it assumes tgat guy&#39;s done/gone, as are all the borrowed handles in it.</span></div>
<div class="line"><a id="l00466" name="l00466"></a><span class="lineno">  466</span><span class="comment">   * That clarification doesn&#39;t change the situation though: Whether it&#39;s the SHM-jemalloc-session, or the</span></div>
<div class="line"><a id="l00467" name="l00467"></a><span class="lineno">  467</span><span class="comment">   * SHM-jemalloc-session-used-channel, or the SHM-jemalloc-arena going away that makes borrowed objects unusable --</span></div>
<div class="line"><a id="l00468" name="l00468"></a><span class="lineno">  468</span><span class="comment">   * they are unusable, is the bottom line.)</span></div>
<div class="line"><a id="l00469" name="l00469"></a><span class="lineno">  469</span><span class="comment">   *</span></div>
<div class="line"><a id="l00470" name="l00470"></a><span class="lineno">  470</span><span class="comment">   * All that is to say: A dtor runs; and user handle to object X in B instantly becomes unusable.</span></div>
<div class="line"><a id="l00471" name="l00471"></a><span class="lineno">  471</span><span class="comment">   * For example, I (ygoldfel) have observed a simple thing: A SHM-jemalloc-backed transport::struc::Msg_in received</span></div>
<div class="line"><a id="l00472" name="l00472"></a><span class="lineno">  472</span><span class="comment">   * from A, in B, was absolutely fine.  Then it was running a long tight-loop verification of its contents -- verifying</span></div>
<div class="line"><a id="l00473" name="l00473"></a><span class="lineno">  473</span><span class="comment">   * hashes of millions of X-pointed objects in SHM, preventing B dtor from running.  Meanwhile, A in a test program</span></div>
<div class="line"><a id="l00474" name="l00474"></a><span class="lineno">  474</span><span class="comment">   * had nothing more to do and ran A dtor (closed session).  Suddenly, the hash-verifier code in the tight loop</span></div>
<div class="line"><a id="l00475" name="l00475"></a><span class="lineno">  475</span><span class="comment">   * was hitting hash mismatches, throwing capnp exceptions in trying to traverse the message, and so on.</span></div>
<div class="line"><a id="l00476" name="l00476"></a><span class="lineno">  476</span><span class="comment">   *</span></div>
<div class="line"><a id="l00477" name="l00477"></a><span class="lineno">  477</span><span class="comment">   * What this means, ultimately, is straightforward: A dtor must not destroy its SHM-jemalloc arena</span></div>
<div class="line"><a id="l00478" name="l00478"></a><span class="lineno">  478</span><span class="comment">   * (as accessible normally through `.session_shm()`), until not just *A* user has dropped all its object</span></div>
<div class="line"><a id="l00479" name="l00479"></a><span class="lineno">  479</span><span class="comment">   * `shared_ptr` handles; but *B* user -- that&#39;s in the other process, B -- has as well!  How can we enforce</span></div>
<div class="line"><a id="l00480" name="l00480"></a><span class="lineno">  480</span><span class="comment">   * this, though?  One approach is to just put it on the user: Tell them that they must design their protocol</span></div>
<div class="line"><a id="l00481" name="l00481"></a><span class="lineno">  481</span><span class="comment">   * in such a way as to arrange some kind of handshake, as appropriate, beyond which each side knows for a fact</span></div>
<div class="line"><a id="l00482" name="l00482"></a><span class="lineno">  482</span><span class="comment">   * that the session objects, and therefore arenas, are safe to destroy.</span></div>
<div class="line"><a id="l00483" name="l00483"></a><span class="lineno">  483</span><span class="comment">   *</span></div>
<div class="line"><a id="l00484" name="l00484"></a><span class="lineno">  484</span><span class="comment">   * We don&#39;t want to do that for obvious reasons.  What we already tell them should be sufficient: If you get</span></div>
<div class="line"><a id="l00485" name="l00485"></a><span class="lineno">  485</span><span class="comment">   * a session-hosing error handler execution in your `Session`, then don&#39;t use that `Session`, and you should</span></div>
<div class="line"><a id="l00486" name="l00486"></a><span class="lineno">  486</span><span class="comment">   * destroy it ASAP, for it is useless, and the other side&#39;s `Session` is not long for this life.  If they</span></div>
<div class="line"><a id="l00487" name="l00487"></a><span class="lineno">  487</span><span class="comment">   * listen to this, then A dtor will soon be followed by B dtor anyway.  It might be delayed by some long</span></div>
<div class="line"><a id="l00488" name="l00488"></a><span class="lineno">  488</span><span class="comment">   * tight-loop operation such as the test-program hash-verifying scenario above, but generally users avoid such</span></div>
<div class="line"><a id="l00489" name="l00489"></a><span class="lineno">  489</span><span class="comment">   * things; and when they don&#39;t they can expect other things to get blocked, possibly in the opposing process.</span></div>
<div class="line"><a id="l00490" name="l00490"></a><span class="lineno">  490</span><span class="comment">   * Subjectively, weird blocking -- caused by the other side acting pathologically -- is a lot more acceptable</span></div>
<div class="line"><a id="l00491" name="l00491"></a><span class="lineno">  491</span><span class="comment">   * at session-start or session-end than something like that occuring mid-session.</span></div>
<div class="line"><a id="l00492" name="l00492"></a><span class="lineno">  492</span><span class="comment">   *</span></div>
<div class="line"><a id="l00493" name="l00493"></a><span class="lineno">  493</span><span class="comment">   * So what&#39;s the exact proposal?  It&#39;s this: If A dtor begins executing, it must first block until it knows</span></div>
<div class="line"><a id="l00494" name="l00494"></a><span class="lineno">  494</span><span class="comment">   * B dtor has begun executing; but once it does know that, it knows that all B-held object handles have been</span></div>
<div class="line"><a id="l00495" name="l00495"></a><span class="lineno">  495</span><span class="comment">   * dropped -- which is what we want.  (It would be possible for B user to indicate it some other way -- another</span></div>
<div class="line"><a id="l00496" name="l00496"></a><span class="lineno">  496</span><span class="comment">   * API call, short of destruction -- but that seems unnecessarily complex/precious.  If the session is finished,</span></div>
<div class="line"><a id="l00497" name="l00497"></a><span class="lineno">  497</span><span class="comment">   * then there&#39;s no reason to keep the `Session` object around = the overall policy we&#39;ve pursued so far, so why</span></div>
<div class="line"><a id="l00498" name="l00498"></a><span class="lineno">  498</span><span class="comment">   * make exceptions for this?)</span></div>
<div class="line"><a id="l00499" name="l00499"></a><span class="lineno">  499</span><span class="comment">   *</span></div>
<div class="line"><a id="l00500" name="l00500"></a><span class="lineno">  500</span><span class="comment">   * To be clear, this means certain behavior by B user can cause A dtor to block.  We can explain this in the docs,</span></div>
<div class="line"><a id="l00501" name="l00501"></a><span class="lineno">  501</span><span class="comment">   * of course, but perhaps much more effective is to make it clear in the logs: say the wait begins here and what</span></div>
<div class="line"><a id="l00502" name="l00502"></a><span class="lineno">  502</span><span class="comment">   * it&#39;ll take for it to end; and say when it has ended and why.</span></div>
<div class="line"><a id="l00503" name="l00503"></a><span class="lineno">  503</span><span class="comment">   *</span></div>
<div class="line"><a id="l00504" name="l00504"></a><span class="lineno">  504</span><span class="comment">   * Also to be clear, Graceful_finisher should be used only in `*_session_impl` pairs that actually have this</span></div>
<div class="line"><a id="l00505" name="l00505"></a><span class="lineno">  505</span><span class="comment">   * problem; so of the 3 pairs we&#39;ve discussed above -- only SHM-jemalloc&#39;s ones.  The others can completely</span></div>
<div class="line"><a id="l00506" name="l00506"></a><span class="lineno">  506</span><span class="comment">   * forego all this.</span></div>
<div class="line"><a id="l00507" name="l00507"></a><span class="lineno">  507</span><span class="comment">   *</span></div>
<div class="line"><a id="l00508" name="l00508"></a><span class="lineno">  508</span><span class="comment">   * @todo Consider how to avoid having SHM-jemalloc ipc::session mechanism require one side&#39;s `Session` dtor</span></div>
<div class="line"><a id="l00509" name="l00509"></a><span class="lineno">  509</span><span class="comment">   * await (and possibly block) the start of the opposing side&#39;s `Session` dtor, before it can proceed.  The</span></div>
<div class="line"><a id="l00510" name="l00510"></a><span class="lineno">  510</span><span class="comment">   * reason it does this today is above this to-do in the code.  The blocking is not too bad -- if the user&#39;s</span></div>
<div class="line"><a id="l00511" name="l00511"></a><span class="lineno">  511</span><span class="comment">   * applications are properly written, it will not occur, and the existing logging should make clear why it</span></div>
<div class="line"><a id="l00512" name="l00512"></a><span class="lineno">  512</span><span class="comment">   * happens, if it happens; but it&#39;s still not ideal.  There are a couple known mitigating approaches,</span></div>
<div class="line"><a id="l00513" name="l00513"></a><span class="lineno">  513</span><span class="comment">   * and at least 1 ticket covering them is likely filed.  (Either way the Graceful_finisher mechanism could</span></div>
<div class="line"><a id="l00514" name="l00514"></a><span class="lineno">  514</span><span class="comment">   * then be removed probably.)  To summarize them: 1, there can be a mechanism deep inside SHM-jemalloc code that gives</span></div>
<div class="line"><a id="l00515" name="l00515"></a><span class="lineno">  515</span><span class="comment">   * (arbitrarily long, configurable) grace period for known borrowed objects whose session channels</span></div>
<div class="line"><a id="l00516" name="l00516"></a><span class="lineno">  516</span><span class="comment">   * have closed before those objects were returned; this was echan&#39;s idea on this topic.  Once the grace period</span></div>
<div class="line"><a id="l00517" name="l00517"></a><span class="lineno">  517</span><span class="comment">   * is reached, it would act as-if they got returned then (so in the above scenario the arena could get</span></div>
<div class="line"><a id="l00518" name="l00518"></a><span class="lineno">  518</span><span class="comment">   * jemalloc-deinitialized and all).  If program needs to exit, it could either block until the end of the</span></div>
<div class="line"><a id="l00519" name="l00519"></a><span class="lineno">  519</span><span class="comment">   * grace period or... who knows?  2, something similar could be done about the SHM-internal-use channel:</span></div>
<div class="line"><a id="l00520" name="l00520"></a><span class="lineno">  520</span><span class="comment">   * do not close it but add it to some list of such channels; they would be finally closed upon detection of</span></div>
<div class="line"><a id="l00521" name="l00521"></a><span class="lineno">  521</span><span class="comment">   * the other side&#39;s `Session` dtor being reached, in some background thread somewhere.  (On 2nd thought</span></div>
<div class="line"><a id="l00522" name="l00522"></a><span class="lineno">  522</span><span class="comment">   * this sounds a lot like Graceful_finisher -- but for this particular internal-use channel only.  The code</span></div>
<div class="line"><a id="l00523" name="l00523"></a><span class="lineno">  523</span><span class="comment">   * here would only get more complex, thought maybe not too much more.  However, it would resolve the observed</span></div>
<div class="line"><a id="l00524" name="l00524"></a><span class="lineno">  524</span><span class="comment">   * `Session`-dtor-blocking user-visible issue, at least until the delayed-channel-death process had to exit</span></div>
<div class="line"><a id="l00525" name="l00525"></a><span class="lineno">  525</span><span class="comment">   * entirely.)  Beyond these basic ideas (which could even perhaps be combined) this requires some thinking;</span></div>
<div class="line"><a id="l00526" name="l00526"></a><span class="lineno">  526</span><span class="comment">   * it is an interesting problem.  In the meantime the dtor-cross-process-barrier-of-sorts existing solution is</span></div>
<div class="line"><a id="l00527" name="l00527"></a><span class="lineno">  527</span><span class="comment">   * pretty decent.</span></div>
<div class="line"><a id="l00528" name="l00528"></a><span class="lineno">  528</span><span class="comment">   *</span></div>
<div class="line"><a id="l00529" name="l00529"></a><span class="lineno">  529</span><span class="comment">   * ### Design / how to use ###</span></div>
<div class="line"><a id="l00530" name="l00530"></a><span class="lineno">  530</span><span class="comment">   * How to use: Subclass shall create a `*this` if and only if the feature is required; it shall call its methods</span></div>
<div class="line"><a id="l00531" name="l00531"></a><span class="lineno">  531</span><span class="comment">   * and ctor on certain events, as prescribed in their doc headers.</span></div>
<div class="line"><a id="l00532" name="l00532"></a><span class="lineno">  532</span><span class="comment">   *</span></div>
<div class="line"><a id="l00533" name="l00533"></a><span class="lineno">  533</span><span class="comment">   * Design: All this assumes PEER state.  Now:</span></div>
<div class="line"><a id="l00534" name="l00534"></a><span class="lineno">  534</span><span class="comment">   *</span></div>
<div class="line"><a id="l00535" name="l00535"></a><span class="lineno">  535</span><span class="comment">   * Again let&#39;s say we&#39;re A, and they&#39;re B -- and just like we are.  Our goal is to ensure A dtor, at its</span></div>
<div class="line"><a id="l00536" name="l00536"></a><span class="lineno">  536</span><span class="comment">   * start, blocks until B dtor has started executing; and to give their side the information necessary to do the</span></div>
<div class="line"><a id="l00537" name="l00537"></a><span class="lineno">  537</span><span class="comment">   * same.  That&#39;s on_dtor_start(): the method that&#39;ll do the blocking; when it returns the dtor of subclass can</span></div>
<div class="line"><a id="l00538" name="l00538"></a><span class="lineno">  538</span><span class="comment">   * proceed.  So what&#39;s needed for on_dtor_start() to `return`?  One, A dtor has to have started -- but that&#39;s true</span></div>
<div class="line"><a id="l00539" name="l00539"></a><span class="lineno">  539</span><span class="comment">   * by the contract of when the method is called; two, B dtor has to have started.  How do we get informed of the</span></div>
<div class="line"><a id="l00540" name="l00540"></a><span class="lineno">  540</span><span class="comment">   * latter?  Answer: B sends a special message along the #Master_structured_channel, from its own on_dtor_start().</span></div>
<div class="line"><a id="l00541" name="l00541"></a><span class="lineno">  541</span><span class="comment">   * Naturally, we do the same -- in full-duplex fashion in a sense -- so that they can use the same logic.  So then</span></div>
<div class="line"><a id="l00542" name="l00542"></a><span class="lineno">  542</span><span class="comment">   * the steps in on_dtor_start() are:</span></div>
<div class="line"><a id="l00543" name="l00543"></a><span class="lineno">  543</span><span class="comment">   *   -# Send `GracefulSessionEnd` message to B, if possible (#Master_structured_channel is up, and the send</span></div>
<div class="line"><a id="l00544" name="l00544"></a><span class="lineno">  544</span><span class="comment">   *      op doesn&#39;t return failure).</span></div>
<div class="line"><a id="l00545" name="l00545"></a><span class="lineno">  545</span><span class="comment">   *   -# Perform `m_opposing_session_done.get_future().wait()`, where `m_opposing_session_done` is a `promise&lt;void&gt;`</span></div>
<div class="line"><a id="l00546" name="l00546"></a><span class="lineno">  546</span><span class="comment">   *      that shall be fulfilled on these events (and only if it hasn&#39;t already been fulfilled before):</span></div>
<div class="line"><a id="l00547" name="l00547"></a><span class="lineno">  547</span><span class="comment">   *      - The #Master_structured_channel has received `GracefulSessionEnd` *from* B.</span></div>
<div class="line"><a id="l00548" name="l00548"></a><span class="lineno">  548</span><span class="comment">   *      - The #Master_structured_channel has emitted a channel-hosing error.</span></div>
<div class="line"><a id="l00549" name="l00549"></a><span class="lineno">  549</span><span class="comment">   *</span></div>
<div class="line"><a id="l00550" name="l00550"></a><span class="lineno">  550</span><span class="comment">   * Notes:</span></div>
<div class="line"><a id="l00551" name="l00551"></a><span class="lineno">  551</span><span class="comment">   *   - The mainstream case is receiving `GracefulSessionEnd`: In normal operation, with no acts of god, we will no</span></div>
<div class="line"><a id="l00552" name="l00552"></a><span class="lineno">  552</span><span class="comment">   *     longer destroy the session-master-channel, until returning from on_dtor_start().</span></div>
<div class="line"><a id="l00553" name="l00553"></a><span class="lineno">  553</span><span class="comment">   *     - This could happen after the `.wait()` starts -- meaning A dtor indeed ran before B dtor (our side is</span></div>
<div class="line"><a id="l00554" name="l00554"></a><span class="lineno">  554</span><span class="comment">   *       the one triggering session-end).</span></div>
<div class="line"><a id="l00555" name="l00555"></a><span class="lineno">  555</span><span class="comment">   *     - It could just as easily happen *before* the `.wait()` starts -- meaning the reverse.  Then `.wait()`</span></div>
<div class="line"><a id="l00556" name="l00556"></a><span class="lineno">  556</span><span class="comment">   *       will return immediately.</span></div>
<div class="line"><a id="l00557" name="l00557"></a><span class="lineno">  557</span><span class="comment">   *   - Of course who knows what&#39;s going on -- the #Master_structured_channel could still go down without</span></div>
<div class="line"><a id="l00558" name="l00558"></a><span class="lineno">  558</span><span class="comment">   *     the `GracefulSessionEnd`.  Is it really right to treat this the same, and let on_dtor_start() return?</span></div>
<div class="line"><a id="l00559" name="l00559"></a><span class="lineno">  559</span><span class="comment">   *     Answer: Yes.  Firstly, there&#39;s hardly any other choice: the channel&#39;s dead; there&#39;s no other way of knowing</span></div>
<div class="line"><a id="l00560" name="l00560"></a><span class="lineno">  560</span><span class="comment">   *     what to wait for; and we can&#39;t just sit there cluelessly.  But more to the point, this means it&#39;s a</span></div>
<div class="line"><a id="l00561" name="l00561"></a><span class="lineno">  561</span><span class="comment">   *     *not*-graceful scenario: Graceful_finisher can&#39;t hope to deal with it and can only proceed heuristically.</span></div>
<div class="line"><a id="l00562" name="l00562"></a><span class="lineno">  562</span><span class="comment">   *     This is not networking; so we should have a pretty good level of predictability at any rate.</span></div>
<div class="line"><a id="l00563" name="l00563"></a><span class="lineno">  563</span><span class="comment">   *</span></div>
<div class="line"><a id="l00564" name="l00564"></a><span class="lineno">  564</span><span class="comment">   * Last but not least consider that by delaying the destruction of the #Master_structured_channel until after</span></div>
<div class="line"><a id="l00565" name="l00565"></a><span class="lineno">  565</span><span class="comment">   * the dtor has started (assuming no channel-hosing acts of god), we&#39;ve changed something: The error handler shall</span></div>
<div class="line"><a id="l00566" name="l00566"></a><span class="lineno">  566</span><span class="comment">   * no longer inform the user of a session-end trigger from the other side!  Left alone this way, we&#39;ve broken</span></div>
<div class="line"><a id="l00567" name="l00567"></a><span class="lineno">  567</span><span class="comment">   * the whole system by introducing a chicken-egg paradox: We don&#39;t let our user be informed of the session-end</span></div>
<div class="line"><a id="l00568" name="l00568"></a><span class="lineno">  568</span><span class="comment">   * trigger when would normally, so they won&#39;t call our dtor; but because they won&#39;t call our dtor, we&#39;ll never</span></div>
<div class="line"><a id="l00569" name="l00569"></a><span class="lineno">  569</span><span class="comment">   * reach the point where the channel would get hosed and we&#39;d know the inform the user.  How to fix this?</span></div>
<div class="line"><a id="l00570" name="l00570"></a><span class="lineno">  570</span><span class="comment">   * The answer is pretty obvious: Receiving the `GracefulSessionEnd` shall now trigger a special graceful-session-end</span></div>
<div class="line"><a id="l00571" name="l00571"></a><span class="lineno">  571</span><span class="comment">   * error.  Naturally this would only be usefully emitted if we&#39;re not in the dtor yet.</span></div>
<div class="line"><a id="l00572" name="l00572"></a><span class="lineno">  572</span><span class="comment">   * So the latter situation should kick-off the user invoking our dtor sometime soon, hopefully; we&#39;ll send our</span></div>
<div class="line"><a id="l00573" name="l00573"></a><span class="lineno">  573</span><span class="comment">   * `GracefulSessionEnd` to them; and so on.</span></div>
<div class="line"><a id="l00574" name="l00574"></a><span class="lineno">  574</span><span class="comment">   */</span></div>
<div class="line"><a id="l00575" name="l00575"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html">  575</a></span>  <span class="keyword">class </span><a class="code hl_class" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html">Graceful_finisher</a> :</div>
<div class="line"><a id="l00576" name="l00576"></a><span class="lineno">  576</span>    <span class="keyword">public</span> flow::log::Log_context,</div>
<div class="line"><a id="l00577" name="l00577"></a><span class="lineno">  577</span>    <span class="keyword">private</span> boost::noncopyable</div>
<div class="line"><a id="l00578" name="l00578"></a><span class="lineno">  578</span>  {</div>
<div class="line"><a id="l00579" name="l00579"></a><span class="lineno">  579</span>  <span class="keyword">public</span>:</div>
<div class="line"><a id="l00580" name="l00580"></a><span class="lineno">  580</span>    <span class="comment">// Constructors/destructor.</span></div>
<div class="line"><a id="l00581" name="l00581"></a><span class="lineno">  581</span><span class="comment"></span> </div>
<div class="line"><a id="l00582" name="l00582"></a><span class="lineno">  582</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00583" name="l00583"></a><span class="lineno">  583</span><span class="comment">     * You must invoke this ctor (instantiate us) if and only if synchronized dtor execution is indeed required;</span></div>
<div class="line"><a id="l00584" name="l00584"></a><span class="lineno">  584</span><span class="comment">     * and `*this_session` has just reached PEER state.  Invoke from thread W only.</span></div>
<div class="line"><a id="l00585" name="l00585"></a><span class="lineno">  585</span><span class="comment">     *</span></div>
<div class="line"><a id="l00586" name="l00586"></a><span class="lineno">  586</span><span class="comment">     * ### How `master_channel` shall be touched by `*this` ###</span></div>
<div class="line"><a id="l00587" name="l00587"></a><span class="lineno">  587</span><span class="comment">     * We&#39;re being very explicit about this, since there&#39;s some inter-class private-state sharing going on...</span></div>
<div class="line"><a id="l00588" name="l00588"></a><span class="lineno">  588</span><span class="comment">     * generally not the most stable or stylistically-amazing situation....</span></div>
<div class="line"><a id="l00589" name="l00589"></a><span class="lineno">  589</span><span class="comment">     *   - This ctor will `.expect_msg(GRACEFUL_SESSION_END)`, so we can detect its arrival and mark it down as needed</span></div>
<div class="line"><a id="l00590" name="l00590"></a><span class="lineno">  590</span><span class="comment">     *     and possibly invoke `this_session-&gt;hose()` to report it to the user.</span></div>
<div class="line"><a id="l00591" name="l00591"></a><span class="lineno">  591</span><span class="comment">     *     Hence there&#39;s no method you&#39;ll need to call nor any setup like this needed on your part.</span></div>
<div class="line"><a id="l00592" name="l00592"></a><span class="lineno">  592</span><span class="comment">     *   - on_dtor_start() will attempt to send `GracefulSessionEnd` to the opposing Graceful_finisher.</span></div>
<div class="line"><a id="l00593" name="l00593"></a><span class="lineno">  593</span><span class="comment">     *</span></div>
<div class="line"><a id="l00594" name="l00594"></a><span class="lineno">  594</span><span class="comment">     * @param logger_ptr</span></div>
<div class="line"><a id="l00595" name="l00595"></a><span class="lineno">  595</span><span class="comment">     *        Logger to use for logging subsequently.  (Maybe `Session_base` should just subclass `Log_context`</span></div>
<div class="line"><a id="l00596" name="l00596"></a><span class="lineno">  596</span><span class="comment">     *        for all os us?  Add to-do?)</span></div>
<div class="line"><a id="l00597" name="l00597"></a><span class="lineno">  597</span><span class="comment">     * @param this_session</span></div>
<div class="line"><a id="l00598" name="l00598"></a><span class="lineno">  598</span><span class="comment">     *        The containing Session_base.</span></div>
<div class="line"><a id="l00599" name="l00599"></a><span class="lineno">  599</span><span class="comment">     * @param async_worker</span></div>
<div class="line"><a id="l00600" name="l00600"></a><span class="lineno">  600</span><span class="comment">     *        The thread W of the containing `*_session_impl`.  `GracefulSessionEnd` handler is at least partially</span></div>
<div class="line"><a id="l00601" name="l00601"></a><span class="lineno">  601</span><span class="comment">     *        invoked there (`hose(...)`); and on_dtor_start() posts onto it.</span></div>
<div class="line"><a id="l00602" name="l00602"></a><span class="lineno">  602</span><span class="comment">     * @param master_channel</span></div>
<div class="line"><a id="l00603" name="l00603"></a><span class="lineno">  603</span><span class="comment">     *        The containing `Session` master channel.  The pointee must exist until `*this` Graceful_finisher</span></div>
<div class="line"><a id="l00604" name="l00604"></a><span class="lineno">  604</span><span class="comment">     *        is gone.</span></div>
<div class="line"><a id="l00605" name="l00605"></a><span class="lineno">  605</span><span class="comment">     */</span></div>
<div class="line"><a id="l00606" name="l00606"></a><span class="lineno">  606</span>    <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a28a9c414cee99b868b2cd291cee24ea0">Graceful_finisher</a>(flow::log::Logger* logger_ptr, <a class="code hl_class" href="classipc_1_1session_1_1Session__base.html">Session_base</a>* this_session,</div>
<div class="line"><a id="l00607" name="l00607"></a><span class="lineno">  607</span>                               flow::async::Single_thread_task_loop* async_worker,</div>
<div class="line"><a id="l00608" name="l00608"></a><span class="lineno">  608</span>                               <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Channel.html">Master_structured_channel</a>* master_channel);</div>
<div class="line"><a id="l00609" name="l00609"></a><span class="lineno">  609</span> </div>
<div class="line"><a id="l00610" name="l00610"></a><span class="lineno">  610</span>    <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00611" name="l00611"></a><span class="lineno">  611</span><span class="comment"></span> </div>
<div class="line"><a id="l00612" name="l00612"></a><span class="lineno">  612</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00613" name="l00613"></a><span class="lineno">  613</span><span class="comment">     * Must be invoked if the `*_session_impl` detects that the master channel has emitted channel-hosing error.</span></div>
<div class="line"><a id="l00614" name="l00614"></a><span class="lineno">  614</span><span class="comment">     *</span></div>
<div class="line"><a id="l00615" name="l00615"></a><span class="lineno">  615</span><span class="comment">     * Invoke from thread W.</span></div>
<div class="line"><a id="l00616" name="l00616"></a><span class="lineno">  616</span><span class="comment">     */</span></div>
<div class="line"><a id="l00617" name="l00617"></a><span class="lineno">  617</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#af7c591a4b774ae52603fa6d890e369f1">on_master_channel_hosed</a>();</div>
<div class="line"><a id="l00618" name="l00618"></a><span class="lineno">  618</span><span class="comment"></span> </div>
<div class="line"><a id="l00619" name="l00619"></a><span class="lineno">  619</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00620" name="l00620"></a><span class="lineno">  620</span><span class="comment">     * The reason Graceful_finisher exists, this method must be called at the start of `*_session_impl` dtor; and</span></div>
<div class="line"><a id="l00621" name="l00621"></a><span class="lineno">  621</span><span class="comment">     * will block until it is appropriate to let that dtor proceed to shut down the `*_session_impl`.</span></div>
<div class="line"><a id="l00622" name="l00622"></a><span class="lineno">  622</span><span class="comment">     *</span></div>
<div class="line"><a id="l00623" name="l00623"></a><span class="lineno">  623</span><span class="comment">     * Invoke from thread U, not thread W.</span></div>
<div class="line"><a id="l00624" name="l00624"></a><span class="lineno">  624</span><span class="comment">     */</span></div>
<div class="line"><a id="l00625" name="l00625"></a><span class="lineno">  625</span>    <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#af441f45ce1ed7b890c3ab77d959f8830">on_dtor_start</a>();</div>
<div class="line"><a id="l00626" name="l00626"></a><span class="lineno">  626</span> </div>
<div class="line"><a id="l00627" name="l00627"></a><span class="lineno">  627</span>  <span class="keyword">private</span>:</div>
<div class="line"><a id="l00628" name="l00628"></a><span class="lineno">  628</span>    <span class="comment">// Data.</span></div>
<div class="line"><a id="l00629" name="l00629"></a><span class="lineno">  629</span><span class="comment"></span> </div>
<div class="line"><a id="l00630" name="l00630"></a><span class="lineno">  630</span><span class="comment">    /// The containing Session_base.  It shall exist until `*this` is gone.</span></div>
<div class="line"><a id="l00631" name="l00631"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#acb037930b23240ecf8975e65f50f3927">  631</a></span><span class="comment"></span>    <a class="code hl_class" href="classipc_1_1session_1_1Session__base.html">Session_base</a>* <span class="keyword">const</span> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#acb037930b23240ecf8975e65f50f3927">m_this_session</a>;</div>
<div class="line"><a id="l00632" name="l00632"></a><span class="lineno">  632</span><span class="comment"></span> </div>
<div class="line"><a id="l00633" name="l00633"></a><span class="lineno">  633</span><span class="comment">    /// The containing `Session` thread W loop.  It shall exist until `*this` is gone.</span></div>
<div class="line"><a id="l00634" name="l00634"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a5de1dea5af9f0ef5558e91ff6484e68d">  634</a></span><span class="comment"></span>    flow::async::Single_thread_task_loop* <a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a5de1dea5af9f0ef5558e91ff6484e68d">m_async_worker</a>;</div>
<div class="line"><a id="l00635" name="l00635"></a><span class="lineno">  635</span><span class="comment"></span> </div>
<div class="line"><a id="l00636" name="l00636"></a><span class="lineno">  636</span><span class="comment">    /// The containing `Session` master channel.  It shall exist until `*this` is gone.</span></div>
<div class="line"><a id="l00637" name="l00637"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a8dd106d9ac3223737dac58d0b056367b">  637</a></span><span class="comment"></span>    <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Channel.html">Master_structured_channel</a>* <a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a8dd106d9ac3223737dac58d0b056367b">m_master_channel</a>;</div>
<div class="line"><a id="l00638" name="l00638"></a><span class="lineno">  638</span><span class="comment"></span> </div>
<div class="line"><a id="l00639" name="l00639"></a><span class="lineno">  639</span><span class="comment">    /**</span></div>
<div class="line"><a id="l00640" name="l00640"></a><span class="lineno">  640</span><span class="comment">     * A promise whose fulfillment is a necessary and sufficient condition for on_dtor_start() returning</span></div>
<div class="line"><a id="l00641" name="l00641"></a><span class="lineno">  641</span><span class="comment">     * (letting `Session` dtor complete).</span></div>
<div class="line"><a id="l00642" name="l00642"></a><span class="lineno">  642</span><span class="comment">     *</span></div>
<div class="line"><a id="l00643" name="l00643"></a><span class="lineno">  643</span><span class="comment">     * It is fulfilled once the #Master_structured_channel receives `GracefulSessionEnd` from opposing side</span></div>
<div class="line"><a id="l00644" name="l00644"></a><span class="lineno">  644</span><span class="comment">     * (indicating the opposing on_dtor_start() has started) or got hosed (indicating we&#39;ll now never know this</span></div>
<div class="line"><a id="l00645" name="l00645"></a><span class="lineno">  645</span><span class="comment">     * and must act as-if opposing on_dtor_start() has started).  See &quot;Design&quot; in our doc header.</span></div>
<div class="line"><a id="l00646" name="l00646"></a><span class="lineno">  646</span><span class="comment">     */</span></div>
<div class="line"><a id="l00647" name="l00647"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#ab1548d77913d3e99e4f30e1dd46f8d86">  647</a></span>    boost::promise&lt;void&gt; <a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#ab1548d77913d3e99e4f30e1dd46f8d86">m_opposing_session_done</a>;</div>
<div class="line"><a id="l00648" name="l00648"></a><span class="lineno">  648</span>  }; <span class="comment">// class Graceful_finisher</span></div>
<div class="line"><a id="l00649" name="l00649"></a><span class="lineno">  649</span> </div>
<div class="line"><a id="l00650" name="l00650"></a><span class="lineno">  650</span>  <span class="comment">// Constructors.</span></div>
<div class="line"><a id="l00651" name="l00651"></a><span class="lineno">  651</span><span class="comment"></span> </div>
<div class="line"><a id="l00652" name="l00652"></a><span class="lineno">  652</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00653" name="l00653"></a><span class="lineno">  653</span><span class="comment">   * Constructs: Client_session_impl form (the user is the one constructing the object, though in NULL state).</span></div>
<div class="line"><a id="l00654" name="l00654"></a><span class="lineno">  654</span><span class="comment">   * The values taken as args are set permanently (undefined behavior/assertion may trip if an attempt is made to</span></div>
<div class="line"><a id="l00655" name="l00655"></a><span class="lineno">  655</span><span class="comment">   * modify one via mutator).  The remaining values must be set via mutator before PEER state.</span></div>
<div class="line"><a id="l00656" name="l00656"></a><span class="lineno">  656</span><span class="comment">   *</span></div>
<div class="line"><a id="l00657" name="l00657"></a><span class="lineno">  657</span><span class="comment">   * @param cli_app_ref</span></div>
<div class="line"><a id="l00658" name="l00658"></a><span class="lineno">  658</span><span class="comment">   *        See cli_app_ptr().</span></div>
<div class="line"><a id="l00659" name="l00659"></a><span class="lineno">  659</span><span class="comment">   * @param srv_app_ref</span></div>
<div class="line"><a id="l00660" name="l00660"></a><span class="lineno">  660</span><span class="comment">   *        See #m_srv_app_ref.</span></div>
<div class="line"><a id="l00661" name="l00661"></a><span class="lineno">  661</span><span class="comment">   * @param on_err_func</span></div>
<div class="line"><a id="l00662" name="l00662"></a><span class="lineno">  662</span><span class="comment">   *        On-error handler from user.</span></div>
<div class="line"><a id="l00663" name="l00663"></a><span class="lineno">  663</span><span class="comment">   * @param on_passive_open_channel_func_or_empty_arg</span></div>
<div class="line"><a id="l00664" name="l00664"></a><span class="lineno">  664</span><span class="comment">   *        On-passive-open handler from user (empty if user wishes the disable passive-opens on this side).</span></div>
<div class="line"><a id="l00665" name="l00665"></a><span class="lineno">  665</span><span class="comment">   */</span></div>
<div class="line"><a id="l00666" name="l00666"></a><span class="lineno">  666</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#aab2db8b2cdb3d8189c1cc497aed7b2b1">Session_base</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp; cli_app_ref, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00667" name="l00667"></a><span class="lineno">  667</span>                        flow::async::Task_asio_err&amp;&amp; on_err_func,</div>
<div class="line"><a id="l00668" name="l00668"></a><span class="lineno">  668</span>                        <a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">On_passive_open_channel_func</a>&amp;&amp; on_passive_open_channel_func_or_empty_arg);</div>
<div class="line"><a id="l00669" name="l00669"></a><span class="lineno">  669</span><span class="comment"></span> </div>
<div class="line"><a id="l00670" name="l00670"></a><span class="lineno">  670</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00671" name="l00671"></a><span class="lineno">  671</span><span class="comment">   * Constructs: Server_session_impl form (Session_server is the one constructing the object, though in NULL state,</span></div>
<div class="line"><a id="l00672" name="l00672"></a><span class="lineno">  672</span><span class="comment">   * before log-in has completed, but after the socket-stream connection has been established).</span></div>
<div class="line"><a id="l00673" name="l00673"></a><span class="lineno">  673</span><span class="comment">   * The values taken as args are set permanently (undefined behavior/assertion may trip if an attempt is made to</span></div>
<div class="line"><a id="l00674" name="l00674"></a><span class="lineno">  674</span><span class="comment">   * modify one via mutator).  The remaining values must be set via mutator before PEER state.</span></div>
<div class="line"><a id="l00675" name="l00675"></a><span class="lineno">  675</span><span class="comment">   *</span></div>
<div class="line"><a id="l00676" name="l00676"></a><span class="lineno">  676</span><span class="comment">   * @param srv_app_ref</span></div>
<div class="line"><a id="l00677" name="l00677"></a><span class="lineno">  677</span><span class="comment">   *        See #m_srv_app_ref.</span></div>
<div class="line"><a id="l00678" name="l00678"></a><span class="lineno">  678</span><span class="comment">   */</span></div>
<div class="line"><a id="l00679" name="l00679"></a><span class="lineno">  679</span>  <span class="keyword">explicit</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#aab2db8b2cdb3d8189c1cc497aed7b2b1">Session_base</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref);</div>
<div class="line"><a id="l00680" name="l00680"></a><span class="lineno">  680</span> </div>
<div class="line"><a id="l00681" name="l00681"></a><span class="lineno">  681</span>  <span class="comment">// Methods.</span></div>
<div class="line"><a id="l00682" name="l00682"></a><span class="lineno">  682</span><span class="comment"></span> </div>
<div class="line"><a id="l00683" name="l00683"></a><span class="lineno">  683</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00684" name="l00684"></a><span class="lineno">  684</span><span class="comment">   * Sets srv_namespace() (do not call if already set).</span></div>
<div class="line"><a id="l00685" name="l00685"></a><span class="lineno">  685</span><span class="comment">   * @param srv_namespace_new</span></div>
<div class="line"><a id="l00686" name="l00686"></a><span class="lineno">  686</span><span class="comment">   *        Value.</span></div>
<div class="line"><a id="l00687" name="l00687"></a><span class="lineno">  687</span><span class="comment">   */</span></div>
<div class="line"><a id="l00688" name="l00688"></a><span class="lineno">  688</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a28825fcdeaf1249a7bf810a3b2ca7c38">set_srv_namespace</a>(<a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp;&amp; srv_namespace_new);</div>
<div class="line"><a id="l00689" name="l00689"></a><span class="lineno">  689</span><span class="comment"></span> </div>
<div class="line"><a id="l00690" name="l00690"></a><span class="lineno">  690</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00691" name="l00691"></a><span class="lineno">  691</span><span class="comment">   * Sets cli_namespace() (do not call if already set).</span></div>
<div class="line"><a id="l00692" name="l00692"></a><span class="lineno">  692</span><span class="comment">   * @param cli_namespace_new</span></div>
<div class="line"><a id="l00693" name="l00693"></a><span class="lineno">  693</span><span class="comment">   *        Value.</span></div>
<div class="line"><a id="l00694" name="l00694"></a><span class="lineno">  694</span><span class="comment">   */</span></div>
<div class="line"><a id="l00695" name="l00695"></a><span class="lineno">  695</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a8cc7a4faa098e0f71c737f44c34d593c">set_cli_namespace</a>(<a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp;&amp; cli_namespace_new);</div>
<div class="line"><a id="l00696" name="l00696"></a><span class="lineno">  696</span><span class="comment"></span> </div>
<div class="line"><a id="l00697" name="l00697"></a><span class="lineno">  697</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00698" name="l00698"></a><span class="lineno">  698</span><span class="comment">   * Sets cli_app_ptr() (do not call if already set).</span></div>
<div class="line"><a id="l00699" name="l00699"></a><span class="lineno">  699</span><span class="comment">   * @param cli_app_ptr_new</span></div>
<div class="line"><a id="l00700" name="l00700"></a><span class="lineno">  700</span><span class="comment">   *        Value.</span></div>
<div class="line"><a id="l00701" name="l00701"></a><span class="lineno">  701</span><span class="comment">   */</span></div>
<div class="line"><a id="l00702" name="l00702"></a><span class="lineno">  702</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a60a081ce0f85651202d23b4d543d093c">set_cli_app_ptr</a>(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>* cli_app_ptr_new);</div>
<div class="line"><a id="l00703" name="l00703"></a><span class="lineno">  703</span><span class="comment"></span> </div>
<div class="line"><a id="l00704" name="l00704"></a><span class="lineno">  704</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00705" name="l00705"></a><span class="lineno">  705</span><span class="comment">   * Sets on_passive_open_channel_func_or_empty() (do not call if already set; do not call if user intends for</span></div>
<div class="line"><a id="l00706" name="l00706"></a><span class="lineno">  706</span><span class="comment">   * passive-opens to be disabled on this side).</span></div>
<div class="line"><a id="l00707" name="l00707"></a><span class="lineno">  707</span><span class="comment">   *</span></div>
<div class="line"><a id="l00708" name="l00708"></a><span class="lineno">  708</span><span class="comment">   * @param on_passive_open_channel_func</span></div>
<div class="line"><a id="l00709" name="l00709"></a><span class="lineno">  709</span><span class="comment">   *        Value.</span></div>
<div class="line"><a id="l00710" name="l00710"></a><span class="lineno">  710</span><span class="comment">   */</span></div>
<div class="line"><a id="l00711" name="l00711"></a><span class="lineno">  711</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a3be1a385c905404621b58c23332b0b96">set_on_passive_open_channel_func</a>(<a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">On_passive_open_channel_func</a>&amp;&amp; on_passive_open_channel_func);</div>
<div class="line"><a id="l00712" name="l00712"></a><span class="lineno">  712</span><span class="comment"></span> </div>
<div class="line"><a id="l00713" name="l00713"></a><span class="lineno">  713</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00714" name="l00714"></a><span class="lineno">  714</span><span class="comment">   * Sets on_err_func() (do not call if already set).</span></div>
<div class="line"><a id="l00715" name="l00715"></a><span class="lineno">  715</span><span class="comment">   *</span></div>
<div class="line"><a id="l00716" name="l00716"></a><span class="lineno">  716</span><span class="comment">   * @param on_err_func_arg</span></div>
<div class="line"><a id="l00717" name="l00717"></a><span class="lineno">  717</span><span class="comment">   *        Value.</span></div>
<div class="line"><a id="l00718" name="l00718"></a><span class="lineno">  718</span><span class="comment">   */</span></div>
<div class="line"><a id="l00719" name="l00719"></a><span class="lineno">  719</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#ae769a82bdec0d16702111ad06716faae">set_on_err_func</a>(flow::async::Task_asio_err&amp;&amp; on_err_func_arg);</div>
<div class="line"><a id="l00720" name="l00720"></a><span class="lineno">  720</span><span class="comment"></span> </div>
<div class="line"><a id="l00721" name="l00721"></a><span class="lineno">  721</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00722" name="l00722"></a><span class="lineno">  722</span><span class="comment">   * Returns `true` if and only if set_on_err_func() has been called.</span></div>
<div class="line"><a id="l00723" name="l00723"></a><span class="lineno">  723</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00724" name="l00724"></a><span class="lineno">  724</span><span class="comment">   */</span></div>
<div class="line"><a id="l00725" name="l00725"></a><span class="lineno">  725</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#aca82817beaac36d0006c44012f9fef03">on_err_func_set</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00726" name="l00726"></a><span class="lineno">  726</span><span class="comment"></span> </div>
<div class="line"><a id="l00727" name="l00727"></a><span class="lineno">  727</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00728" name="l00728"></a><span class="lineno">  728</span><span class="comment">   * The on-passive-open handler (may be empty even in final state, meaning user wants passive-opens disabled</span></div>
<div class="line"><a id="l00729" name="l00729"></a><span class="lineno">  729</span><span class="comment">   * on this side).</span></div>
<div class="line"><a id="l00730" name="l00730"></a><span class="lineno">  730</span><span class="comment">   * @return See above.</span></div>
<div class="line"><a id="l00731" name="l00731"></a><span class="lineno">  731</span><span class="comment">   */</span></div>
<div class="line"><a id="l00732" name="l00732"></a><span class="lineno">  732</span>  <span class="keyword">const</span> <a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">On_passive_open_channel_func</a>&amp; <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a21b146b02d257d95f4aaeaca12b8d320">on_passive_open_channel_func_or_empty</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00733" name="l00733"></a><span class="lineno">  733</span><span class="comment"></span> </div>
<div class="line"><a id="l00734" name="l00734"></a><span class="lineno">  734</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00735" name="l00735"></a><span class="lineno">  735</span><span class="comment">   * Marks this session as hosed for (truthy) reason `err_code`; and *synchronously* invokes on-error handler;</span></div>
<div class="line"><a id="l00736" name="l00736"></a><span class="lineno">  736</span><span class="comment">   * only invoke if not already hosed().</span></div>
<div class="line"><a id="l00737" name="l00737"></a><span class="lineno">  737</span><span class="comment">   *</span></div>
<div class="line"><a id="l00738" name="l00738"></a><span class="lineno">  738</span><span class="comment">   * This utility is important and has certain pre-conditions (behavior undefined if not met; assertion may trip):</span></div>
<div class="line"><a id="l00739" name="l00739"></a><span class="lineno">  739</span><span class="comment">   *   - `*this` must be in PEER state.  In particular on_err_func_set() must return `true`.</span></div>
<div class="line"><a id="l00740" name="l00740"></a><span class="lineno">  740</span><span class="comment">   *   - hosed() must return `false`.</span></div>
<div class="line"><a id="l00741" name="l00741"></a><span class="lineno">  741</span><span class="comment">   *   - `err_code` must be truthy (non-success).</span></div>
<div class="line"><a id="l00742" name="l00742"></a><span class="lineno">  742</span><span class="comment">   *   - This must be invoked from a thread such that it is OK to *synchronously* invoke on-error handler.</span></div>
<div class="line"><a id="l00743" name="l00743"></a><span class="lineno">  743</span><span class="comment">   *     As of this writing this is Server_session_impl&#39;s or Client_session_impl&#39;s thread W in practice, which is how</span></div>
<div class="line"><a id="l00744" name="l00744"></a><span class="lineno">  744</span><span class="comment">   *     thread safety of hose() versus hosed() is also guaranteed by those users.</span></div>
<div class="line"><a id="l00745" name="l00745"></a><span class="lineno">  745</span><span class="comment">   *</span></div>
<div class="line"><a id="l00746" name="l00746"></a><span class="lineno">  746</span><span class="comment">   * @param err_code</span></div>
<div class="line"><a id="l00747" name="l00747"></a><span class="lineno">  747</span><span class="comment">   *        Truthy error.</span></div>
<div class="line"><a id="l00748" name="l00748"></a><span class="lineno">  748</span><span class="comment">   */</span></div>
<div class="line"><a id="l00749" name="l00749"></a><span class="lineno">  749</span>  <span class="keywordtype">void</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a7f9e67dccbab4f3191734c2834bafb63">hose</a>(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>&amp; err_code);</div>
<div class="line"><a id="l00750" name="l00750"></a><span class="lineno">  750</span><span class="comment"></span> </div>
<div class="line"><a id="l00751" name="l00751"></a><span class="lineno">  751</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00752" name="l00752"></a><span class="lineno">  752</span><span class="comment">   * Returns `true` if and only if hose() has been called.  If so then #m_on_err_func has been executed already.</span></div>
<div class="line"><a id="l00753" name="l00753"></a><span class="lineno">  753</span><span class="comment">   * `*this` must be in PEER state.  In particular on_err_func_set() must return `true`.</span></div>
<div class="line"><a id="l00754" name="l00754"></a><span class="lineno">  754</span><span class="comment">   *</span></div>
<div class="line"><a id="l00755" name="l00755"></a><span class="lineno">  755</span><span class="comment">   * @return Ditto.</span></div>
<div class="line"><a id="l00756" name="l00756"></a><span class="lineno">  756</span><span class="comment">   */</span></div>
<div class="line"><a id="l00757" name="l00757"></a><span class="lineno">  757</span>  <span class="keywordtype">bool</span> <a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a398f3e6a30b3fae8e110af9fd1ff75e3">hosed</a>() <span class="keyword">const</span>;</div>
<div class="line"><a id="l00758" name="l00758"></a><span class="lineno">  758</span> </div>
<div class="line"><a id="l00759" name="l00759"></a><span class="lineno">  759</span><span class="keyword">private</span>:</div>
<div class="line"><a id="l00760" name="l00760"></a><span class="lineno">  760</span>  <span class="comment">// Data.</span></div>
<div class="line"><a id="l00761" name="l00761"></a><span class="lineno">  761</span><span class="comment"></span> </div>
<div class="line"><a id="l00762" name="l00762"></a><span class="lineno">  762</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00763" name="l00763"></a><span class="lineno">  763</span><span class="comment">   * See cli_app_ptr().</span></div>
<div class="line"><a id="l00764" name="l00764"></a><span class="lineno">  764</span><span class="comment">   *</span></div>
<div class="line"><a id="l00765" name="l00765"></a><span class="lineno">  765</span><span class="comment">   * ### Rationale for it being `atomic&lt;&gt;` ###</span></div>
<div class="line"><a id="l00766" name="l00766"></a><span class="lineno">  766</span><span class="comment">   * It is for the following specific reason.  Consider `ostream&lt;&lt;` of `*this`.  `*this` is really either</span></div>
<div class="line"><a id="l00767" name="l00767"></a><span class="lineno">  767</span><span class="comment">   * in Client_session_impl or Server_session_impl.  In both cases these `ostream&lt;&lt;`s access only #m_srv_app_ref, which</span></div>
<div class="line"><a id="l00768" name="l00768"></a><span class="lineno">  768</span><span class="comment">   * is immutable throughout (so no problem there) and #m_cli_app_ptr.  For Client_session_impl #m_cli_app_ptr is</span></div>
<div class="line"><a id="l00769" name="l00769"></a><span class="lineno">  769</span><span class="comment">   * also immutable throughout (so no problem there).  For Server_session_impl however it does change in one spot:</span></div>
<div class="line"><a id="l00770" name="l00770"></a><span class="lineno">  770</span><span class="comment">   * Server_session_impl::async_accept_log_in() internal async handler for the log-in request shall, on success,</span></div>
<div class="line"><a id="l00771" name="l00771"></a><span class="lineno">  771</span><span class="comment">   * call set_cli_app_ptr() and change it from null to non-null.  This could cause concurrent access to the</span></div>
<div class="line"><a id="l00772" name="l00772"></a><span class="lineno">  772</span><span class="comment">   * data member, even though it&#39;s a mere pointer (but we don&#39;t count on the alleged &quot;atomicity&quot; of this; it is</span></div>
<div class="line"><a id="l00773" name="l00773"></a><span class="lineno">  773</span><span class="comment">   * generally considered not safe).</span></div>
<div class="line"><a id="l00774" name="l00774"></a><span class="lineno">  774</span><span class="comment">   *</span></div>
<div class="line"><a id="l00775" name="l00775"></a><span class="lineno">  775</span><span class="comment">   * Now, as of this writing, there&#39;s exactly one spot where `ostream&lt;&lt;` could be invoked from thread U while</span></div>
<div class="line"><a id="l00776" name="l00776"></a><span class="lineno">  776</span><span class="comment">   * it is being assigned in thread W: `async_accept_log_in()` is called by our internal code in</span></div>
<div class="line"><a id="l00777" name="l00777"></a><span class="lineno">  777</span><span class="comment">   * Session_server and only once; the only thing that can occur in thread U until the log-in response</span></div>
<div class="line"><a id="l00778" name="l00778"></a><span class="lineno">  778</span><span class="comment">   * handler is executed is that Server_session_impl dtor is called.  Before that dtor stops that thread W,</span></div>
<div class="line"><a id="l00779" name="l00779"></a><span class="lineno">  779</span><span class="comment">   * it does print the Server_session_impl once as of this writing.  Therefore, out of sheer caution, this guy</span></div>
<div class="line"><a id="l00780" name="l00780"></a><span class="lineno">  780</span><span class="comment">   * is `atomic&lt;&gt;`.  That said there could be other such invocations, as code might change during maintenance</span></div>
<div class="line"><a id="l00781" name="l00781"></a><span class="lineno">  781</span><span class="comment">   * in the future, in which case this `atomic&lt;&gt;`ness will quietly come in handy.</span></div>
<div class="line"><a id="l00782" name="l00782"></a><span class="lineno">  782</span><span class="comment">   */</span></div>
<div class="line"><a id="l00783" name="l00783"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#aa8cccc9369af1dff6b59dee1a12f72d8">  783</a></span>  std::atomic&lt;const Client_app*&gt; <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#aa8cccc9369af1dff6b59dee1a12f72d8">m_cli_app_ptr</a>;</div>
<div class="line"><a id="l00784" name="l00784"></a><span class="lineno">  784</span><span class="comment"></span> </div>
<div class="line"><a id="l00785" name="l00785"></a><span class="lineno">  785</span><span class="comment">  /// See srv_namespace().</span></div>
<div class="line"><a id="l00786" name="l00786"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a60a30526bad0c8db6ad05ede618a22bd">  786</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a60a30526bad0c8db6ad05ede618a22bd">m_srv_namespace</a>;</div>
<div class="line"><a id="l00787" name="l00787"></a><span class="lineno">  787</span><span class="comment"></span> </div>
<div class="line"><a id="l00788" name="l00788"></a><span class="lineno">  788</span><span class="comment">  /// See cli_namespace().</span></div>
<div class="line"><a id="l00789" name="l00789"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a2985006a6526c86ce3ed5497cb7f5b64">  789</a></span><span class="comment"></span>  <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a2985006a6526c86ce3ed5497cb7f5b64">m_cli_namespace</a>;</div>
<div class="line"><a id="l00790" name="l00790"></a><span class="lineno">  790</span><span class="comment"></span> </div>
<div class="line"><a id="l00791" name="l00791"></a><span class="lineno">  791</span><span class="comment">  /// See set_on_err_func().</span></div>
<div class="line"><a id="l00792" name="l00792"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a7d25e45d33beb8af9ae03b05d676b0e4">  792</a></span><span class="comment"></span>  flow::async::Task_asio_err <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a7d25e45d33beb8af9ae03b05d676b0e4">m_on_err_func</a>;</div>
<div class="line"><a id="l00793" name="l00793"></a><span class="lineno">  793</span><span class="comment"></span> </div>
<div class="line"><a id="l00794" name="l00794"></a><span class="lineno">  794</span><span class="comment">  /// See on_passive_open_channel_func_or_empty().</span></div>
<div class="line"><a id="l00795" name="l00795"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#ad28de3ad7ea872adb52e3a826602d333">  795</a></span><span class="comment"></span>  <a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">On_passive_open_channel_func</a> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#ad28de3ad7ea872adb52e3a826602d333">m_on_passive_open_channel_func_or_empty</a>;</div>
<div class="line"><a id="l00796" name="l00796"></a><span class="lineno">  796</span><span class="comment"></span> </div>
<div class="line"><a id="l00797" name="l00797"></a><span class="lineno">  797</span><span class="comment">  /**</span></div>
<div class="line"><a id="l00798" name="l00798"></a><span class="lineno">  798</span><span class="comment">   * Starts falsy; becomes forever truthy (with a specific #Error_code that will not change thereafter)</span></div>
<div class="line"><a id="l00799" name="l00799"></a><span class="lineno">  799</span><span class="comment">   * once hose() is called (with that truthy value).  Note hose() may not be called before PEER state, which implies</span></div>
<div class="line"><a id="l00800" name="l00800"></a><span class="lineno">  800</span><span class="comment">   * #m_on_err_func is non-empty.</span></div>
<div class="line"><a id="l00801" name="l00801"></a><span class="lineno">  801</span><span class="comment">   *</span></div>
<div class="line"><a id="l00802" name="l00802"></a><span class="lineno">  802</span><span class="comment">   * ### Concurrency ###</span></div>
<div class="line"><a id="l00803" name="l00803"></a><span class="lineno">  803</span><span class="comment">   * See hose() and hosed() doc headers.  TL;DR: It is up to the caller to only call those, basically, from</span></div>
<div class="line"><a id="l00804" name="l00804"></a><span class="lineno">  804</span><span class="comment">   * thread W only.</span></div>
<div class="line"><a id="l00805" name="l00805"></a><span class="lineno">  805</span><span class="comment">   */</span></div>
<div class="line"><a id="l00806" name="l00806"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a0d7926326671d05679c53e5e3991603e">  806</a></span>  <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> <a class="code hl_variable" href="classipc_1_1session_1_1Session__base.html#a0d7926326671d05679c53e5e3991603e">m_peer_state_err_code_or_ok</a>;</div>
<div class="line"><a id="l00807" name="l00807"></a><span class="lineno">  807</span>}; <span class="comment">// class Session_base</span></div>
<div class="line"><a id="l00808" name="l00808"></a><span class="lineno">  808</span><span class="comment"></span> </div>
<div class="line"><a id="l00809" name="l00809"></a><span class="lineno">  809</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00810" name="l00810"></a><span class="lineno"><a class="line" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">  810</a></span><span class="comment"></span><span class="preprocessor">#define TEMPLATE_SESSION_BASE \</span></div>
<div class="line"><a id="l00811" name="l00811"></a><span class="lineno">  811</span><span class="preprocessor">  template&lt;schema::MqType S_MQ_TYPE_OR_NONE, bool S_TRANSMIT_NATIVE_HANDLES, typename Mdt_payload&gt;</span><span class="comment"></span></div>
<div class="line"><a id="l00812" name="l00812"></a><span class="lineno">  812</span><span class="comment">/// Internally used macro; public API users should disregard (same deal as in struc/channel.hpp).</span></div>
<div class="line"><a id="l00813" name="l00813"></a><span class="lineno"><a class="line" href="session__base_8hpp.html#a044c7bbedc3036505d4430a389f43709">  813</a></span><span class="comment"></span><span class="preprocessor">#define CLASS_SESSION_BASE \</span></div>
<div class="line"><a id="l00814" name="l00814"></a><span class="lineno">  814</span><span class="preprocessor">  Session_base&lt;S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES, Mdt_payload&gt;</span></div>
<div class="line"><a id="l00815" name="l00815"></a><span class="lineno">  815</span> </div>
<div class="line"><a id="l00816" name="l00816"></a><span class="lineno">  816</span><span class="comment">// Template implementations.</span></div>
<div class="line"><a id="l00817" name="l00817"></a><span class="lineno">  817</span> </div>
<div class="line"><a id="l00818" name="l00818"></a><span class="lineno">  818</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00819" name="l00819"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#aab2db8b2cdb3d8189c1cc497aed7b2b1">  819</a></span>CLASS_SESSION_BASE::Session_base(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>&amp; cli_app_ref, <span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref,</div>
<div class="line"><a id="l00820" name="l00820"></a><span class="lineno">  820</span>                                 flow::async::Task_asio_err&amp;&amp; on_err_func,</div>
<div class="line"><a id="l00821" name="l00821"></a><span class="lineno">  821</span>                                 <a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">On_passive_open_channel_func</a>&amp;&amp; on_passive_open_channel_func_or_empty_arg) :</div>
<div class="line"><a id="l00822" name="l00822"></a><span class="lineno">  822</span>  <span class="comment">/* This is, basically, the (protected) ctor for Client_session, followed by Client_session_impl::async_connect().</span></div>
<div class="line"><a id="l00823" name="l00823"></a><span class="lineno">  823</span><span class="comment">   * By the time we&#39;re constructed, by definition Client_app and, therefore-ish, m_on_*_func are known.</span></div>
<div class="line"><a id="l00824" name="l00824"></a><span class="lineno">  824</span><span class="comment">   * However: m_srv_namespace is looked-up (in file system, as of this writing) at the forthcoming async_connect();</span></div>
<div class="line"><a id="l00825" name="l00825"></a><span class="lineno">  825</span><span class="comment">   * empty for now; set_srv_namespace() invoked at that time.   m_cli_namespace is returned by server in</span></div>
<div class="line"><a id="l00826" name="l00826"></a><span class="lineno">  826</span><span class="comment">   * log-in response; set_cli_namespace() invoked at that time. */</span></div>
<div class="line"><a id="l00827" name="l00827"></a><span class="lineno">  827</span> </div>
<div class="line"><a id="l00828" name="l00828"></a><span class="lineno">  828</span>  m_srv_app_ref(srv_app_ref), <span class="comment">// Not copied!</span></div>
<div class="line"><a id="l00829" name="l00829"></a><span class="lineno">  829</span>  m_cli_app_ptr(&amp;cli_app_ref), <span class="comment">// Ditto!</span></div>
<div class="line"><a id="l00830" name="l00830"></a><span class="lineno">  830</span>  m_on_err_func(std::move(on_err_func)),</div>
<div class="line"><a id="l00831" name="l00831"></a><span class="lineno">  831</span>  m_on_passive_open_channel_func_or_empty(std::move(on_passive_open_channel_func_or_empty_arg))</div>
<div class="line"><a id="l00832" name="l00832"></a><span class="lineno">  832</span>  <span class="comment">// m_srv_namespace and m_cli_namespace remain .empty() for now.</span></div>
<div class="line"><a id="l00833" name="l00833"></a><span class="lineno">  833</span>{</div>
<div class="line"><a id="l00834" name="l00834"></a><span class="lineno">  834</span>  <span class="comment">// Yep.</span></div>
<div class="line"><a id="l00835" name="l00835"></a><span class="lineno">  835</span>}</div>
<div class="line"><a id="l00836" name="l00836"></a><span class="lineno">  836</span> </div>
<div class="line"><a id="l00837" name="l00837"></a><span class="lineno">  837</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00838" name="l00838"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a8d323ca75006777b3fc929bd0720f7df">  838</a></span>CLASS_SESSION_BASE::Session_base(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Server__app.html">Server_app</a>&amp; srv_app_ref) :</div>
<div class="line"><a id="l00839" name="l00839"></a><span class="lineno">  839</span>  <span class="comment">/* This is, basically, the (protected) ctor for Server_session, followed by</span></div>
<div class="line"><a id="l00840" name="l00840"></a><span class="lineno">  840</span><span class="comment">   * Server_session_impl::async_accept_log_in(), itself `protected` as of this writing.  Various items are not</span></div>
<div class="line"><a id="l00841" name="l00841"></a><span class="lineno">  841</span><span class="comment">   * known until that async-succeeds; Client_app is not known (until it is identified in the log-in exchange), and,</span></div>
<div class="line"><a id="l00842" name="l00842"></a><span class="lineno">  842</span><span class="comment">   * therefore-ish, m_on_*_func are also unknown.</span></div>
<div class="line"><a id="l00843" name="l00843"></a><span class="lineno">  843</span><span class="comment">   * Server_app is still known from the very start.  Moreover, due to the way m_srv_namespace is determined (our own</span></div>
<div class="line"><a id="l00844" name="l00844"></a><span class="lineno">  844</span><span class="comment">   * PID), we can confidently initialize that from the start (ourselves being the server).</span></div>
<div class="line"><a id="l00845" name="l00845"></a><span class="lineno">  845</span><span class="comment">   * m_cli_namespace is generated on server side during log-in proceedings; set_cli_namespace() invoked at that time. */</span></div>
<div class="line"><a id="l00846" name="l00846"></a><span class="lineno">  846</span> </div>
<div class="line"><a id="l00847" name="l00847"></a><span class="lineno">  847</span>  m_srv_app_ref(srv_app_ref), <span class="comment">// Not copied!</span></div>
<div class="line"><a id="l00848" name="l00848"></a><span class="lineno">  848</span>  m_cli_app_ptr(0), <span class="comment">// null for now.</span></div>
<div class="line"><a id="l00849" name="l00849"></a><span class="lineno">  849</span>  <span class="comment">// As promised, we know our own srv-namespace:</span></div>
<div class="line"><a id="l00850" name="l00850"></a><span class="lineno">  850</span>  m_srv_namespace(<a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>::ct(std::to_string(util::Process_credentials::own_process_id())))</div>
<div class="line"><a id="l00851" name="l00851"></a><span class="lineno">  851</span>  <span class="comment">// m_cli_namespace + m_on_err_func and m_on_passive_open_channel_func_or_empty remain .empty() for now.</span></div>
<div class="line"><a id="l00852" name="l00852"></a><span class="lineno">  852</span>{</div>
<div class="line"><a id="l00853" name="l00853"></a><span class="lineno">  853</span>  <span class="comment">// Yep.</span></div>
<div class="line"><a id="l00854" name="l00854"></a><span class="lineno">  854</span>}</div>
<div class="line"><a id="l00855" name="l00855"></a><span class="lineno">  855</span> </div>
<div class="line"><a id="l00856" name="l00856"></a><span class="lineno">  856</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00857" name="l00857"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a60a081ce0f85651202d23b4d543d093c">  857</a></span><span class="keywordtype">void</span> CLASS_SESSION_BASE::set_cli_app_ptr(<span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>* cli_app_ptr_new)</div>
<div class="line"><a id="l00858" name="l00858"></a><span class="lineno">  858</span>{</div>
<div class="line"><a id="l00859" name="l00859"></a><span class="lineno">  859</span>  assert(cli_app_ptr_new &amp;&amp; <span class="stringliteral">&quot;As of this writing cli_app_ptr should be set at most once, from null to non-null.&quot;</span>);</div>
<div class="line"><a id="l00860" name="l00860"></a><span class="lineno">  860</span> </div>
<div class="line"><a id="l00861" name="l00861"></a><span class="lineno">  861</span><span class="preprocessor">#ifndef NDEBUG</span></div>
<div class="line"><a id="l00862" name="l00862"></a><span class="lineno">  862</span>  <span class="keyword">const</span> <span class="keyword">auto</span> prev = m_cli_app_ptr.exchange(cli_app_ptr_new);</div>
<div class="line"><a id="l00863" name="l00863"></a><span class="lineno">  863</span>  assert((!prev) &amp;&amp; <span class="stringliteral">&quot;As of this writing cli_app_ptr should be set at most once, from null to non-null.&quot;</span>);</div>
<div class="line"><a id="l00864" name="l00864"></a><span class="lineno">  864</span><span class="preprocessor">#else</span></div>
<div class="line"><a id="l00865" name="l00865"></a><span class="lineno">  865</span>  m_cli_app_ptr = cli_app_ptr_new;</div>
<div class="line"><a id="l00866" name="l00866"></a><span class="lineno">  866</span><span class="preprocessor">#endif</span></div>
<div class="line"><a id="l00867" name="l00867"></a><span class="lineno">  867</span>}</div>
<div class="line"><a id="l00868" name="l00868"></a><span class="lineno">  868</span> </div>
<div class="line"><a id="l00869" name="l00869"></a><span class="lineno">  869</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00870" name="l00870"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a28825fcdeaf1249a7bf810a3b2ca7c38">  870</a></span><span class="keywordtype">void</span> CLASS_SESSION_BASE::set_srv_namespace(<a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp;&amp; srv_namespace_new)</div>
<div class="line"><a id="l00871" name="l00871"></a><span class="lineno">  871</span>{</div>
<div class="line"><a id="l00872" name="l00872"></a><span class="lineno">  872</span>  assert(!srv_namespace_new.empty());</div>
<div class="line"><a id="l00873" name="l00873"></a><span class="lineno">  873</span>  assert((srv_namespace_new != <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">Shared_name::S_SENTINEL</a>) &amp;&amp; <span class="stringliteral">&quot;That is a reserved sentinel value.&quot;</span>);</div>
<div class="line"><a id="l00874" name="l00874"></a><span class="lineno">  874</span>  assert(m_srv_namespace.empty() &amp;&amp; <span class="stringliteral">&quot;As of this writing srv_namespace should be set at most once, from empty.&quot;</span>);</div>
<div class="line"><a id="l00875" name="l00875"></a><span class="lineno">  875</span> </div>
<div class="line"><a id="l00876" name="l00876"></a><span class="lineno">  876</span>  m_srv_namespace = std::move(srv_namespace_new);</div>
<div class="line"><a id="l00877" name="l00877"></a><span class="lineno">  877</span>}</div>
<div class="line"><a id="l00878" name="l00878"></a><span class="lineno">  878</span> </div>
<div class="line"><a id="l00879" name="l00879"></a><span class="lineno">  879</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00880" name="l00880"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a8cc7a4faa098e0f71c737f44c34d593c">  880</a></span><span class="keywordtype">void</span> CLASS_SESSION_BASE::set_cli_namespace(<a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp;&amp; cli_namespace_new)</div>
<div class="line"><a id="l00881" name="l00881"></a><span class="lineno">  881</span>{</div>
<div class="line"><a id="l00882" name="l00882"></a><span class="lineno">  882</span>  assert(!cli_namespace_new.empty());</div>
<div class="line"><a id="l00883" name="l00883"></a><span class="lineno">  883</span>  assert((cli_namespace_new != <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">Shared_name::S_SENTINEL</a>) &amp;&amp; <span class="stringliteral">&quot;That is a reserved sentinel value.&quot;</span>);</div>
<div class="line"><a id="l00884" name="l00884"></a><span class="lineno">  884</span>  assert(m_cli_namespace.empty() &amp;&amp; <span class="stringliteral">&quot;As of this writing cli_namespace should be set at most once, from empty.&quot;</span>);</div>
<div class="line"><a id="l00885" name="l00885"></a><span class="lineno">  885</span> </div>
<div class="line"><a id="l00886" name="l00886"></a><span class="lineno">  886</span>  m_cli_namespace = std::move(cli_namespace_new);</div>
<div class="line"><a id="l00887" name="l00887"></a><span class="lineno">  887</span>}</div>
<div class="line"><a id="l00888" name="l00888"></a><span class="lineno">  888</span> </div>
<div class="line"><a id="l00889" name="l00889"></a><span class="lineno">  889</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00890" name="l00890"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a3be1a385c905404621b58c23332b0b96">  890</a></span><span class="keywordtype">void</span> CLASS_SESSION_BASE::set_on_passive_open_channel_func(<a class="code hl_typedef" href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">On_passive_open_channel_func</a>&amp;&amp; on_passive_open_channel_func)</div>
<div class="line"><a id="l00891" name="l00891"></a><span class="lineno">  891</span>{</div>
<div class="line"><a id="l00892" name="l00892"></a><span class="lineno">  892</span>  assert(m_on_passive_open_channel_func_or_empty.empty());</div>
<div class="line"><a id="l00893" name="l00893"></a><span class="lineno">  893</span>  m_on_passive_open_channel_func_or_empty = std::move(on_passive_open_channel_func);</div>
<div class="line"><a id="l00894" name="l00894"></a><span class="lineno">  894</span>}</div>
<div class="line"><a id="l00895" name="l00895"></a><span class="lineno">  895</span> </div>
<div class="line"><a id="l00896" name="l00896"></a><span class="lineno">  896</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00897" name="l00897"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#ae769a82bdec0d16702111ad06716faae">  897</a></span><span class="keywordtype">void</span> CLASS_SESSION_BASE::set_on_err_func(flow::async::Task_asio_err&amp;&amp; on_err_func_arg)</div>
<div class="line"><a id="l00898" name="l00898"></a><span class="lineno">  898</span>{</div>
<div class="line"><a id="l00899" name="l00899"></a><span class="lineno">  899</span>  assert(!on_err_func_arg.empty());</div>
<div class="line"><a id="l00900" name="l00900"></a><span class="lineno">  900</span>  assert(m_on_err_func.empty() &amp;&amp; <span class="stringliteral">&quot;Call set_on_err_func() once at most and only if not already set through ctor.&quot;</span>);</div>
<div class="line"><a id="l00901" name="l00901"></a><span class="lineno">  901</span> </div>
<div class="line"><a id="l00902" name="l00902"></a><span class="lineno">  902</span>  m_on_err_func = std::move(on_err_func_arg);</div>
<div class="line"><a id="l00903" name="l00903"></a><span class="lineno">  903</span>}</div>
<div class="line"><a id="l00904" name="l00904"></a><span class="lineno">  904</span> </div>
<div class="line"><a id="l00905" name="l00905"></a><span class="lineno">  905</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00906" name="l00906"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a3ebdafe7e70719e6d12dd0b15ae85106">  906</a></span><span class="keyword">const</span> <a class="code hl_struct" href="structipc_1_1session_1_1Client__app.html">Client_app</a>* CLASS_SESSION_BASE::cli_app_ptr()<span class="keyword"> const</span></div>
<div class="line"><a id="l00907" name="l00907"></a><span class="lineno">  907</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00908" name="l00908"></a><span class="lineno">  908</span>  <span class="keywordflow">return</span> m_cli_app_ptr.load(); <span class="comment">// Fetch atomic&lt;&gt; payload and return it.  (Could write `return m_cli_app_ptr;` too.)</span></div>
<div class="line"><a id="l00909" name="l00909"></a><span class="lineno">  909</span>}</div>
<div class="line"><a id="l00910" name="l00910"></a><span class="lineno">  910</span> </div>
<div class="line"><a id="l00911" name="l00911"></a><span class="lineno">  911</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00912" name="l00912"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a4d1327608d6067ed6690bd4efa323c6f">  912</a></span><span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; CLASS_SESSION_BASE::srv_namespace()<span class="keyword"> const</span></div>
<div class="line"><a id="l00913" name="l00913"></a><span class="lineno">  913</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00914" name="l00914"></a><span class="lineno">  914</span>  <span class="keywordflow">return</span> m_srv_namespace;</div>
<div class="line"><a id="l00915" name="l00915"></a><span class="lineno">  915</span>}</div>
<div class="line"><a id="l00916" name="l00916"></a><span class="lineno">  916</span> </div>
<div class="line"><a id="l00917" name="l00917"></a><span class="lineno">  917</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00918" name="l00918"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#abd1e814b3b640f4bdaa2553352405f26">  918</a></span><span class="keyword">const</span> <a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a>&amp; CLASS_SESSION_BASE::cli_namespace()<span class="keyword"> const</span></div>
<div class="line"><a id="l00919" name="l00919"></a><span class="lineno">  919</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00920" name="l00920"></a><span class="lineno">  920</span>  <span class="keywordflow">return</span> m_cli_namespace;</div>
<div class="line"><a id="l00921" name="l00921"></a><span class="lineno">  921</span>}</div>
<div class="line"><a id="l00922" name="l00922"></a><span class="lineno">  922</span> </div>
<div class="line"><a id="l00923" name="l00923"></a><span class="lineno">  923</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00924" name="l00924"></a><span class="lineno">  924</span><span class="keyword">const</span> <span class="keyword">typename</span> CLASS_SESSION_BASE::On_passive_open_channel_func&amp;</div>
<div class="line"><a id="l00925" name="l00925"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a21b146b02d257d95f4aaeaca12b8d320">  925</a></span>  CLASS_SESSION_BASE::on_passive_open_channel_func_or_empty()<span class="keyword"> const</span></div>
<div class="line"><a id="l00926" name="l00926"></a><span class="lineno">  926</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00927" name="l00927"></a><span class="lineno">  927</span>  <span class="keywordflow">return</span> m_on_passive_open_channel_func_or_empty;</div>
<div class="line"><a id="l00928" name="l00928"></a><span class="lineno">  928</span>}</div>
<div class="line"><a id="l00929" name="l00929"></a><span class="lineno">  929</span> </div>
<div class="line"><a id="l00930" name="l00930"></a><span class="lineno">  930</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00931" name="l00931"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#aca82817beaac36d0006c44012f9fef03">  931</a></span><span class="keywordtype">bool</span> CLASS_SESSION_BASE::on_err_func_set()<span class="keyword"> const</span></div>
<div class="line"><a id="l00932" name="l00932"></a><span class="lineno">  932</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00933" name="l00933"></a><span class="lineno">  933</span>  <span class="keywordflow">return</span> !m_on_err_func.empty();</div>
<div class="line"><a id="l00934" name="l00934"></a><span class="lineno">  934</span>}</div>
<div class="line"><a id="l00935" name="l00935"></a><span class="lineno">  935</span> </div>
<div class="line"><a id="l00936" name="l00936"></a><span class="lineno">  936</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00937" name="l00937"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a7f9e67dccbab4f3191734c2834bafb63">  937</a></span><span class="keywordtype">void</span> CLASS_SESSION_BASE::hose(<span class="keyword">const</span> <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a>&amp; err_code)</div>
<div class="line"><a id="l00938" name="l00938"></a><span class="lineno">  938</span>{</div>
<div class="line"><a id="l00939" name="l00939"></a><span class="lineno">  939</span>  assert((!hosed()) &amp;&amp; <span class="stringliteral">&quot;By contract do not call unless hosed() is false.&quot;</span>);</div>
<div class="line"><a id="l00940" name="l00940"></a><span class="lineno">  940</span> </div>
<div class="line"><a id="l00941" name="l00941"></a><span class="lineno">  941</span>  m_peer_state_err_code_or_ok = err_code;</div>
<div class="line"><a id="l00942" name="l00942"></a><span class="lineno">  942</span>  m_on_err_func(err_code);</div>
<div class="line"><a id="l00943" name="l00943"></a><span class="lineno">  943</span>} <span class="comment">// Session_base::hose()</span></div>
<div class="line"><a id="l00944" name="l00944"></a><span class="lineno">  944</span> </div>
<div class="line"><a id="l00945" name="l00945"></a><span class="lineno">  945</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00946" name="l00946"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a398f3e6a30b3fae8e110af9fd1ff75e3">  946</a></span><span class="keywordtype">bool</span> CLASS_SESSION_BASE::hosed()<span class="keyword"> const</span></div>
<div class="line"><a id="l00947" name="l00947"></a><span class="lineno">  947</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00948" name="l00948"></a><span class="lineno">  948</span>  assert(on_err_func_set() &amp;&amp; <span class="stringliteral">&quot;By contract do not call until PEER state -- when on-error handler must be known.&quot;</span>);</div>
<div class="line"><a id="l00949" name="l00949"></a><span class="lineno">  949</span>  <span class="keywordflow">return</span> bool(m_peer_state_err_code_or_ok);</div>
<div class="line"><a id="l00950" name="l00950"></a><span class="lineno">  950</span>}</div>
<div class="line"><a id="l00951" name="l00951"></a><span class="lineno">  951</span> </div>
<div class="line"><a id="l00952" name="l00952"></a><span class="lineno">  952</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00953" name="l00953"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a09cbe99083616bae00928f8e37c8373b">  953</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> CLASS_SESSION_BASE::cur_ns_store_mutex_absolute_name()<span class="keyword"> const</span></div>
<div class="line"><a id="l00954" name="l00954"></a><span class="lineno">  954</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00955" name="l00955"></a><span class="lineno">  955</span>  <span class="keyword">using </span>std::to_string;</div>
<div class="line"><a id="l00956" name="l00956"></a><span class="lineno">  956</span> </div>
<div class="line"><a id="l00957" name="l00957"></a><span class="lineno">  957</span>  <span class="comment">// Global scope.  Pertains to Server_app::m_name, *all* processes thereof, *all* Client_apps, *all* sessions.</span></div>
<div class="line"><a id="l00958" name="l00958"></a><span class="lineno">  958</span>  <span class="keyword">auto</span> mutex_name = <a class="code hl_function" href="namespaceipc_1_1session.html#a365d2d63f77b738e67e206af6b702634">build_conventional_shared_name</a>(<a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a50cb5d2ad8f8b4391e1885e7b8f63890">Shared_name::S_RESOURCE_TYPE_ID_MUTEX</a>,</div>
<div class="line"><a id="l00959" name="l00959"></a><span class="lineno">  959</span>                                                   <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">Shared_name::ct</a>(m_srv_app_ref.m_name),</div>
<div class="line"><a id="l00960" name="l00960"></a><span class="lineno">  960</span>                                                   <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">Shared_name::S_SENTINEL</a>);</div>
<div class="line"><a id="l00961" name="l00961"></a><span class="lineno">  961</span>  <span class="comment">/* That was the standard stuff.  Now the us-specific stuff:</span></div>
<div class="line"><a id="l00962" name="l00962"></a><span class="lineno">  962</span><span class="comment">   *</span></div>
<div class="line"><a id="l00963" name="l00963"></a><span class="lineno">  963</span><span class="comment">   * Above we specified it&#39;s a mutex; now for what&#39;s this mutex?  It&#39;s for the CNS (Current Namespace Store),</span></div>
<div class="line"><a id="l00964" name="l00964"></a><span class="lineno">  964</span><span class="comment">   * a/k/a the PID file. */</span></div>
<div class="line"><a id="l00965" name="l00965"></a><span class="lineno">  965</span>  mutex_name /= <span class="stringliteral">&quot;cur_ns_store&quot;</span>;</div>
<div class="line"><a id="l00966" name="l00966"></a><span class="lineno">  966</span> </div>
<div class="line"><a id="l00967" name="l00967"></a><span class="lineno">  967</span>  <span class="comment">/* Further differentiate the names by owner/permissions that will be used when creating the file.</span></div>
<div class="line"><a id="l00968" name="l00968"></a><span class="lineno">  968</span><span class="comment">   * This is in response to seeing, during testing, the situation where (in that particular case)</span></div>
<div class="line"><a id="l00969" name="l00969"></a><span class="lineno">  969</span><span class="comment">   * m_permissions_level_for_client_apps changed from an accidental S_NO_ACCESS to S_(something sane).</span></div>
<div class="line"><a id="l00970" name="l00970"></a><span class="lineno">  970</span><span class="comment">   * The file was created with 0000 permissions, then later no one could open it (or create it, since it existed)</span></div>
<div class="line"><a id="l00971" name="l00971"></a><span class="lineno">  971</span><span class="comment">   * due to it being untouchable, essentially forever without manual intervention (such as `rm`ing it).</span></div>
<div class="line"><a id="l00972" name="l00972"></a><span class="lineno">  972</span><span class="comment">   * The following, which should be otherwise harmless, should at least help avoid such conflicts.</span></div>
<div class="line"><a id="l00973" name="l00973"></a><span class="lineno">  973</span><span class="comment">   * (Is it harmless?  Almost, yes: more files can potentially be created and sit around until reboot;</span></div>
<div class="line"><a id="l00974" name="l00974"></a><span class="lineno">  974</span><span class="comment">   * but they are tiny.) */</span></div>
<div class="line"><a id="l00975" name="l00975"></a><span class="lineno">  975</span>  mutex_name /= <span class="charliteral">&#39;u&#39;</span>;</div>
<div class="line"><a id="l00976" name="l00976"></a><span class="lineno">  976</span>  mutex_name += to_string(m_srv_app_ref.m_user_id);</div>
<div class="line"><a id="l00977" name="l00977"></a><span class="lineno">  977</span>  mutex_name += <span class="charliteral">&#39;g&#39;</span>;</div>
<div class="line"><a id="l00978" name="l00978"></a><span class="lineno">  978</span>  mutex_name += to_string(m_srv_app_ref.m_group_id);</div>
<div class="line"><a id="l00979" name="l00979"></a><span class="lineno">  979</span>  mutex_name += <span class="charliteral">&#39;p&#39;</span>;</div>
<div class="line"><a id="l00980" name="l00980"></a><span class="lineno">  980</span>  mutex_name += to_string(<span class="keywordtype">int</span>(m_srv_app_ref.m_permissions_level_for_client_apps));</div>
<div class="line"><a id="l00981" name="l00981"></a><span class="lineno">  981</span> </div>
<div class="line"><a id="l00982" name="l00982"></a><span class="lineno">  982</span>  <span class="keywordflow">return</span> mutex_name;</div>
<div class="line"><a id="l00983" name="l00983"></a><span class="lineno">  983</span>} <span class="comment">// Session_base::cur_ns_store_mutex_absolute_name()</span></div>
<div class="line"><a id="l00984" name="l00984"></a><span class="lineno">  984</span> </div>
<div class="line"><a id="l00985" name="l00985"></a><span class="lineno">  985</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00986" name="l00986"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#af059faab56cdf384873f9f2aba8f79cf">  986</a></span>fs::path CLASS_SESSION_BASE::cur_ns_store_absolute_path()<span class="keyword"> const</span></div>
<div class="line"><a id="l00987" name="l00987"></a><span class="lineno">  987</span><span class="keyword"></span>{</div>
<div class="line"><a id="l00988" name="l00988"></a><span class="lineno">  988</span>  <span class="keyword">using </span>Path = fs::path;</div>
<div class="line"><a id="l00989" name="l00989"></a><span class="lineno">  989</span> </div>
<div class="line"><a id="l00990" name="l00990"></a><span class="lineno">  990</span>  Path path(m_srv_app_ref.m_kernel_persistent_run_dir_override.empty()</div>
<div class="line"><a id="l00991" name="l00991"></a><span class="lineno">  991</span>              ? <a class="code hl_variable" href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">util::IPC_KERNEL_PERSISTENT_RUN_DIR</a></div>
<div class="line"><a id="l00992" name="l00992"></a><span class="lineno">  992</span>              : m_srv_app_ref.m_kernel_persistent_run_dir_override);</div>
<div class="line"><a id="l00993" name="l00993"></a><span class="lineno">  993</span>  path /= m_srv_app_ref.m_name;</div>
<div class="line"><a id="l00994" name="l00994"></a><span class="lineno">  994</span>  path += <span class="stringliteral">&quot;.libipc-cns.pid&quot;</span>;</div>
<div class="line"><a id="l00995" name="l00995"></a><span class="lineno">  995</span>  <span class="keywordflow">return</span> path;</div>
<div class="line"><a id="l00996" name="l00996"></a><span class="lineno">  996</span>}</div>
<div class="line"><a id="l00997" name="l00997"></a><span class="lineno">  997</span> </div>
<div class="line"><a id="l00998" name="l00998"></a><span class="lineno">  998</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l00999" name="l00999"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a3d34c5a9c283a6b7c8ab943f344cdd28">  999</a></span><a class="code hl_class" href="classipc_1_1util_1_1Shared__name.html">Shared_name</a> CLASS_SESSION_BASE::session_master_socket_stream_acceptor_absolute_name()<span class="keyword"> const</span></div>
<div class="line"><a id="l01000" name="l01000"></a><span class="lineno"> 1000</span><span class="keyword"></span>{</div>
<div class="line"><a id="l01001" name="l01001"></a><span class="lineno"> 1001</span>  assert((!m_srv_namespace.empty()) &amp;&amp; <span class="stringliteral">&quot;Serv-namespace must have been set by set_srv_namespace() by now.&quot;</span>);</div>
<div class="line"><a id="l01002" name="l01002"></a><span class="lineno"> 1002</span> </div>
<div class="line"><a id="l01003" name="l01003"></a><span class="lineno"> 1003</span>  <span class="comment">// Global scope.  Pertains to Server_app::m_name, the particular process, *all* Client_apps, *all* sessions.</span></div>
<div class="line"><a id="l01004" name="l01004"></a><span class="lineno"> 1004</span>  <span class="keyword">auto</span> acc_name = <a class="code hl_function" href="namespaceipc_1_1session.html#a365d2d63f77b738e67e206af6b702634">build_conventional_shared_name</a>(<a class="code hl_variable" href="classipc_1_1transport_1_1Native__socket__stream__acceptor.html#a0de2b6072026584ff1d46538533ed68b">transport::Native_socket_stream_acceptor::S_RESOURCE_TYPE_ID</a>,</div>
<div class="line"><a id="l01005" name="l01005"></a><span class="lineno"> 1005</span>                                                 <a class="code hl_function" href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">Shared_name::ct</a>(m_srv_app_ref.m_name),</div>
<div class="line"><a id="l01006" name="l01006"></a><span class="lineno"> 1006</span>                                                 m_srv_namespace);</div>
<div class="line"><a id="l01007" name="l01007"></a><span class="lineno"> 1007</span>  <span class="comment">/* That was the standard stuff.  Now the us-specific stuff:</span></div>
<div class="line"><a id="l01008" name="l01008"></a><span class="lineno"> 1008</span><span class="comment">   *</span></div>
<div class="line"><a id="l01009" name="l01009"></a><span class="lineno"> 1009</span><span class="comment">   * Above we specified it&#39;s a socket stream acceptor; but which one/for what?  It&#39;s the required one for</span></div>
<div class="line"><a id="l01010" name="l01010"></a><span class="lineno"> 1010</span><span class="comment">   * any further IPC; hence S_SENTINEL, `0`.  (As of this writing, in ipc::session anyway, we don&#39;t have any other use</span></div>
<div class="line"><a id="l01011" name="l01011"></a><span class="lineno"> 1011</span><span class="comment">   * for Native_socket_stream_acceptor (other socket streams are opened through the ones birthed through this one).</span></div>
<div class="line"><a id="l01012" name="l01012"></a><span class="lineno"> 1012</span><span class="comment">   * If we did, we could use `1`, `2`, etc., or something.  Anyway Shared_name::S_SENTINEL here is a solid choice.) */</span></div>
<div class="line"><a id="l01013" name="l01013"></a><span class="lineno"> 1013</span>  acc_name /= <a class="code hl_variable" href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">Shared_name::S_SENTINEL</a>;</div>
<div class="line"><a id="l01014" name="l01014"></a><span class="lineno"> 1014</span> </div>
<div class="line"><a id="l01015" name="l01015"></a><span class="lineno"> 1015</span>  <span class="keywordflow">return</span> acc_name;</div>
<div class="line"><a id="l01016" name="l01016"></a><span class="lineno"> 1016</span>} <span class="comment">// Session_base::session_master_socket_stream_acceptor_absolute_name()</span></div>
<div class="line"><a id="l01017" name="l01017"></a><span class="lineno"> 1017</span> </div>
<div class="line"><a id="l01018" name="l01018"></a><span class="lineno"> 1018</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l01019" name="l01019"></a><span class="lineno"> 1019</span><span class="keyword">typename</span> CLASS_SESSION_BASE::Structured_msg_builder_config</div>
<div class="line"><a id="l01020" name="l01020"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a08b3d69a6707dcbb233076b7a48de285"> 1020</a></span>  CLASS_SESSION_BASE::heap_fixed_builder_config(flow::log::Logger* logger_ptr) <span class="comment">// Static.</span></div>
<div class="line"><a id="l01021" name="l01021"></a><span class="lineno"> 1021</span>{</div>
<div class="line"><a id="l01022" name="l01022"></a><span class="lineno"> 1022</span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html">transport::sync_io::Native_socket_stream</a>;</div>
<div class="line"><a id="l01023" name="l01023"></a><span class="lineno"> 1023</span>  <span class="keyword">using </span><a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">transport::struc::Heap_fixed_builder</a>;</div>
<div class="line"><a id="l01024" name="l01024"></a><span class="lineno"> 1024</span> </div>
<div class="line"><a id="l01025" name="l01025"></a><span class="lineno"> 1025</span>  <span class="comment">/* This is arguably easiest when one has an actual Channel_obj; see struc::Channel::heap_fixed_builder_config()</span></div>
<div class="line"><a id="l01026" name="l01026"></a><span class="lineno"> 1026</span><span class="comment">   * which works with that.  Then one can query the Channel_obj for its send-blob/meta-blob-max-size(s), pick the</span></div>
<div class="line"><a id="l01027" name="l01027"></a><span class="lineno"> 1027</span><span class="comment">   * smaller, and return that.  We are static -- the whole point is to still work when one doesn&#39;t have an actual</span></div>
<div class="line"><a id="l01028" name="l01028"></a><span class="lineno"> 1028</span><span class="comment">   * channel but might still want to construct a transport::struc::Msg_out -- in fact they might not even have a Session</span></div>
<div class="line"><a id="l01029" name="l01029"></a><span class="lineno"> 1029</span><span class="comment">   * in our case.  Not a big deal: we use similar logic but have to use some specific knowledge about how</span></div>
<div class="line"><a id="l01030" name="l01030"></a><span class="lineno"> 1030</span><span class="comment">   * we use our own class template params (S_MQ_TYPE_OR_NONE, S_TRANSMIT_NATIVE_HANDLES) to configure any channels</span></div>
<div class="line"><a id="l01031" name="l01031"></a><span class="lineno"> 1031</span><span class="comment">   * we open; this tells us how big the messages the various pipes (we ourselves set up) can send-out.</span></div>
<div class="line"><a id="l01032" name="l01032"></a><span class="lineno"> 1032</span><span class="comment">   *</span></div>
<div class="line"><a id="l01033" name="l01033"></a><span class="lineno"> 1033</span><span class="comment">   * So follow along that other method&#39;s (rather simple) procedure and apply our &quot;insider&quot; knowledge.  Namely:</span></div>
<div class="line"><a id="l01034" name="l01034"></a><span class="lineno"> 1034</span><span class="comment">   * We will *specifically* either use an MQ (of one of 2 specific types), or a socket stream, or both.</span></div>
<div class="line"><a id="l01035" name="l01035"></a><span class="lineno"> 1035</span><span class="comment">   * - If socket stream *only*: Then Native_socket_stream advertises its blob/meta-blob max-size in a</span></div>
<div class="line"><a id="l01036" name="l01036"></a><span class="lineno"> 1036</span><span class="comment">   *   non-concept-implementing public constant.  Use that; simple.</span></div>
<div class="line"><a id="l01037" name="l01037"></a><span class="lineno"> 1037</span><span class="comment">   * - If MQ *only*: Not quite as simple; the message max size is configurable at run time, and we don&#39;t have</span></div>
<div class="line"><a id="l01038" name="l01038"></a><span class="lineno"> 1038</span><span class="comment">   *   the actual MQ object (by definition).  Not to worry:</span></div>
<div class="line"><a id="l01039" name="l01039"></a><span class="lineno"> 1039</span><span class="comment">   *   - Suppose we&#39;re really Server_session_impl.  Yay: we are the ones, in Server_session_impl::make_channel_mqs(),</span></div>
<div class="line"><a id="l01040" name="l01040"></a><span class="lineno"> 1040</span><span class="comment">   *     who determine the MQ size, for any channel that is opened.  It&#39;s a constant... so use that constant!</span></div>
<div class="line"><a id="l01041" name="l01041"></a><span class="lineno"> 1041</span><span class="comment">   *   - Suppose we&#39;re really Client_session_impl.  That&#39;s slightly annoying, as the opposing Server_session_impl is</span></div>
<div class="line"><a id="l01042" name="l01042"></a><span class="lineno"> 1042</span><span class="comment">   *     technically determining the MQ size (prev bullet).  As of this writing, though, it&#39;s always been a constant</span></div>
<div class="line"><a id="l01043" name="l01043"></a><span class="lineno"> 1043</span><span class="comment">   *     which has never changed.  So we can just use that same constant.  In the future, *technically*, the</span></div>
<div class="line"><a id="l01044" name="l01044"></a><span class="lineno"> 1044</span><span class="comment">   *     procedure could change -- but we punt on dealing with until such time that&#39;s an actual worry.</span></div>
<div class="line"><a id="l01045" name="l01045"></a><span class="lineno"> 1045</span><span class="comment">   *     The constant&#39;s doc header has notes about it, so it won&#39;t be overlooked.  (Spoiler alert: It&#39;s unlikely</span></div>
<div class="line"><a id="l01046" name="l01046"></a><span class="lineno"> 1046</span><span class="comment">   *     there will be a pressing need to mess with this; SHM-based transmission obviates the need for such</span></div>
<div class="line"><a id="l01047" name="l01047"></a><span class="lineno"> 1047</span><span class="comment">   *     perf tweaking.)</span></div>
<div class="line"><a id="l01048" name="l01048"></a><span class="lineno"> 1048</span><span class="comment">   * - If both: Use the lower of the two (as as in struc::Channel::heap_fixed_builder_config()). */</span></div>
<div class="line"><a id="l01049" name="l01049"></a><span class="lineno"> 1049</span> </div>
<div class="line"><a id="l01050" name="l01050"></a><span class="lineno"> 1050</span>  <span class="keywordtype">size_t</span> sz;</div>
<div class="line"><a id="l01051" name="l01051"></a><span class="lineno"> 1051</span>  <span class="keywordflow">if</span> <span class="keyword">constexpr</span>(S_MQS_ENABLED &amp;&amp; (!S_SOCKET_STREAM_ENABLED))</div>
<div class="line"><a id="l01052" name="l01052"></a><span class="lineno"> 1052</span>  {</div>
<div class="line"><a id="l01053" name="l01053"></a><span class="lineno"> 1053</span>    sz = S_MQS_MAX_MSG_SZ;</div>
<div class="line"><a id="l01054" name="l01054"></a><span class="lineno"> 1054</span>  }</div>
<div class="line"><a id="l01055" name="l01055"></a><span class="lineno"> 1055</span>  <span class="keywordflow">else</span> <span class="keywordflow">if</span> <span class="keyword">constexpr</span>((!S_MQS_ENABLED) &amp;&amp; S_SOCKET_STREAM_ENABLED)</div>
<div class="line"><a id="l01056" name="l01056"></a><span class="lineno"> 1056</span>  {</div>
<div class="line"><a id="l01057" name="l01057"></a><span class="lineno"> 1057</span>    sz = Native_socket_stream::S_MAX_META_BLOB_LENGTH;</div>
<div class="line"><a id="l01058" name="l01058"></a><span class="lineno"> 1058</span>  }</div>
<div class="line"><a id="l01059" name="l01059"></a><span class="lineno"> 1059</span>  <span class="keywordflow">else</span></div>
<div class="line"><a id="l01060" name="l01060"></a><span class="lineno"> 1060</span>  {</div>
<div class="line"><a id="l01061" name="l01061"></a><span class="lineno"> 1061</span>    <span class="keyword">static_assert</span>(S_MQS_ENABLED &amp;&amp; S_SOCKET_STREAM_ENABLED, <span class="stringliteral">&quot;There must be *some* transport mechanism.&quot;</span>);</div>
<div class="line"><a id="l01062" name="l01062"></a><span class="lineno"> 1062</span> </div>
<div class="line"><a id="l01063" name="l01063"></a><span class="lineno"> 1063</span>    sz = std::min(S_MQS_MAX_MSG_SZ, Native_socket_stream::S_MAX_META_BLOB_LENGTH);</div>
<div class="line"><a id="l01064" name="l01064"></a><span class="lineno"> 1064</span>  }</div>
<div class="line"><a id="l01065" name="l01065"></a><span class="lineno"> 1065</span> </div>
<div class="line"><a id="l01066" name="l01066"></a><span class="lineno"> 1066</span>  <span class="keywordflow">return</span> Heap_fixed_builder::Config{ logger_ptr, sz, 0, 0 };</div>
<div class="line"><a id="l01067" name="l01067"></a><span class="lineno"> 1067</span>} <span class="comment">// Session_base::heap_fixed_builder_config()</span></div>
<div class="line"><a id="l01068" name="l01068"></a><span class="lineno"> 1068</span> </div>
<div class="line"><a id="l01069" name="l01069"></a><span class="lineno"> 1069</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l01070" name="l01070"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a28a9c414cee99b868b2cd291cee24ea0"> 1070</a></span>CLASS_SESSION_BASE::Graceful_finisher::Graceful_finisher(flow::log::Logger* logger_ptr, <a class="code hl_class" href="classipc_1_1session_1_1Session__base.html">Session_base</a>* this_session,</div>
<div class="line"><a id="l01071" name="l01071"></a><span class="lineno"> 1071</span>                                                         flow::async::Single_thread_task_loop* async_worker,</div>
<div class="line"><a id="l01072" name="l01072"></a><span class="lineno"> 1072</span>                                                         <a class="code hl_class" href="classipc_1_1transport_1_1struc_1_1Channel.html">Master_structured_channel</a>* master_channel) :</div>
<div class="line"><a id="l01073" name="l01073"></a><span class="lineno"> 1073</span>  flow::log::Log_context(logger_ptr, <a class="code hl_enumeration" href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7">Log_component</a>::S_SESSION),</div>
<div class="line"><a id="l01074" name="l01074"></a><span class="lineno"> 1074</span>  m_this_session(this_session),</div>
<div class="line"><a id="l01075" name="l01075"></a><span class="lineno"> 1075</span>  m_async_worker(async_worker),</div>
<div class="line"><a id="l01076" name="l01076"></a><span class="lineno"> 1076</span>  m_master_channel(master_channel)</div>
<div class="line"><a id="l01077" name="l01077"></a><span class="lineno"> 1077</span>{</div>
<div class="line"><a id="l01078" name="l01078"></a><span class="lineno"> 1078</span>  <span class="comment">// We are in thread W.</span></div>
<div class="line"><a id="l01079" name="l01079"></a><span class="lineno"> 1079</span> </div>
<div class="line"><a id="l01080" name="l01080"></a><span class="lineno"> 1080</span>  <a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a8dd106d9ac3223737dac58d0b056367b">m_master_channel</a>-&gt;<a class="code hl_function" href="classipc_1_1transport_1_1struc_1_1Channel.html#a160a8d49624f15a2596ee7b0244584b0">expect_msg</a>(Master_structured_channel::Msg_which_in::GRACEFUL_SESSION_END,</div>
<div class="line"><a id="l01081" name="l01081"></a><span class="lineno"> 1081</span>                               [<span class="keyword">this</span>](<span class="keyword">auto</span>&amp;&amp;)</div>
<div class="line"><a id="l01082" name="l01082"></a><span class="lineno"> 1082</span>                               <span class="comment">// (The message doesn&#39;t matter and contains no fields; only that we received it matters.)</span></div>
<div class="line"><a id="l01083" name="l01083"></a><span class="lineno"> 1083</span>  {</div>
<div class="line"><a id="l01084" name="l01084"></a><span class="lineno"> 1084</span>    <span class="comment">// We are in thread Wc (unspecified, really struc::Channel async callback thread).</span></div>
<div class="line"><a id="l01085" name="l01085"></a><span class="lineno"> 1085</span>    <a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a5de1dea5af9f0ef5558e91ff6484e68d">m_async_worker</a>-&gt;post([<span class="keyword">this</span>]()</div>
<div class="line"><a id="l01086" name="l01086"></a><span class="lineno"> 1086</span>    {</div>
<div class="line"><a id="l01087" name="l01087"></a><span class="lineno"> 1087</span>      <span class="comment">// We are in thread W.  (We need to be to safely trigger hosed() and hose().)</span></div>
<div class="line"><a id="l01088" name="l01088"></a><span class="lineno"> 1088</span> </div>
<div class="line"><a id="l01089" name="l01089"></a><span class="lineno"> 1089</span>      FLOW_LOG_INFO(<span class="stringliteral">&quot;Received GracefulSessionEnd from opposing Session object along session master channel &quot;</span></div>
<div class="line"><a id="l01090" name="l01090"></a><span class="lineno"> 1090</span>                    <span class="stringliteral">&quot;[&quot;</span> &lt;&lt; *<a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a8dd106d9ac3223737dac58d0b056367b">m_master_channel</a> &lt;&lt; <span class="stringliteral">&quot;].  Will emit to local user as graceful-end &quot;</span></div>
<div class="line"><a id="l01091" name="l01091"></a><span class="lineno"> 1091</span>                    <span class="stringliteral">&quot;error; and mark it down.  If our Session dtor is running, it shall return soon.  If it has &quot;</span></div>
<div class="line"><a id="l01092" name="l01092"></a><span class="lineno"> 1092</span>                    <span class="stringliteral">&quot;not yet run, it shall return immediately upon starting to execute.&quot;</span>);</div>
<div class="line"><a id="l01093" name="l01093"></a><span class="lineno"> 1093</span> </div>
<div class="line"><a id="l01094" name="l01094"></a><span class="lineno"> 1094</span>      <a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#ab1548d77913d3e99e4f30e1dd46f8d86">m_opposing_session_done</a>.set_value();</div>
<div class="line"><a id="l01095" name="l01095"></a><span class="lineno"> 1095</span>      <span class="comment">/* Can m_opposing_session_done already be set?  (That would throw promise exception, and we don&#39;t catch it</span></div>
<div class="line"><a id="l01096" name="l01096"></a><span class="lineno"> 1096</span><span class="comment">       * above.)  Answer: no, in the current protocol at least: Only once can it be sent (hence .expect_msg(), not</span></div>
<div class="line"><a id="l01097" name="l01097"></a><span class="lineno"> 1097</span><span class="comment">       * .expect_msgs()); and if *m_master_channel were to be hosed, then that would occur either after</span></div>
<div class="line"><a id="l01098" name="l01098"></a><span class="lineno"> 1098</span><span class="comment">       * expect_msg() firing handler, or it would occur instead of it.  (We *do* handle the &quot;after&quot; case in</span></div>
<div class="line"><a id="l01099" name="l01099"></a><span class="lineno"> 1099</span><span class="comment">       * on_master_channel_hosed(), where we do indeed catch the exception.) */</span></div>
<div class="line"><a id="l01100" name="l01100"></a><span class="lineno"> 1100</span> </div>
<div class="line"><a id="l01101" name="l01101"></a><span class="lineno"> 1101</span>      <span class="keywordflow">if</span> (!<a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#acb037930b23240ecf8975e65f50f3927">m_this_session</a>-&gt;<a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a398f3e6a30b3fae8e110af9fd1ff75e3">hosed</a>())</div>
<div class="line"><a id="l01102" name="l01102"></a><span class="lineno"> 1102</span>      {</div>
<div class="line"><a id="l01103" name="l01103"></a><span class="lineno"> 1103</span>        <a class="code hl_variable" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#acb037930b23240ecf8975e65f50f3927">m_this_session</a>-&gt;<a class="code hl_function" href="classipc_1_1session_1_1Session__base.html#a7f9e67dccbab4f3191734c2834bafb63">hose</a>(<a class="code hl_enumvalue" href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759">error::Code::S_SESSION_FINISHED</a>); <span class="comment">// It&#39;ll log.</span></div>
<div class="line"><a id="l01104" name="l01104"></a><span class="lineno"> 1104</span>      }</div>
<div class="line"><a id="l01105" name="l01105"></a><span class="lineno"> 1105</span>    }); <span class="comment">// m_async_worker-&gt;post()</span></div>
<div class="line"><a id="l01106" name="l01106"></a><span class="lineno"> 1106</span>  }); <span class="comment">// m_master_channel-&gt;expect_msg(GRACEFUL_SESSION_END)</span></div>
<div class="line"><a id="l01107" name="l01107"></a><span class="lineno"> 1107</span>} <span class="comment">// Session_base::Graceful_finisher::Graceful_finisher()</span></div>
<div class="line"><a id="l01108" name="l01108"></a><span class="lineno"> 1108</span> </div>
<div class="line"><a id="l01109" name="l01109"></a><span class="lineno"> 1109</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l01110" name="l01110"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#af7c591a4b774ae52603fa6d890e369f1"> 1110</a></span><span class="keywordtype">void</span> CLASS_SESSION_BASE::Graceful_finisher::on_master_channel_hosed()</div>
<div class="line"><a id="l01111" name="l01111"></a><span class="lineno"> 1111</span>{</div>
<div class="line"><a id="l01112" name="l01112"></a><span class="lineno"> 1112</span>  <span class="keyword">using </span>boost::promise_already_satisfied;</div>
<div class="line"><a id="l01113" name="l01113"></a><span class="lineno"> 1113</span> </div>
<div class="line"><a id="l01114" name="l01114"></a><span class="lineno"> 1114</span>  <span class="comment">// We are in thread W.</span></div>
<div class="line"><a id="l01115" name="l01115"></a><span class="lineno"> 1115</span>  <span class="keywordflow">try</span></div>
<div class="line"><a id="l01116" name="l01116"></a><span class="lineno"> 1116</span>  {</div>
<div class="line"><a id="l01117" name="l01117"></a><span class="lineno"> 1117</span>    m_opposing_session_done.set_value();</div>
<div class="line"><a id="l01118" name="l01118"></a><span class="lineno"> 1118</span>  }</div>
<div class="line"><a id="l01119" name="l01119"></a><span class="lineno"> 1119</span>  <span class="keywordflow">catch</span> (<span class="keyword">const</span> promise_already_satisfied&amp;)</div>
<div class="line"><a id="l01120" name="l01120"></a><span class="lineno"> 1120</span>  {</div>
<div class="line"><a id="l01121" name="l01121"></a><span class="lineno"> 1121</span>    <span class="comment">// Interesting.  @todo Maybe log?</span></div>
<div class="line"><a id="l01122" name="l01122"></a><span class="lineno"> 1122</span>  }</div>
<div class="line"><a id="l01123" name="l01123"></a><span class="lineno"> 1123</span>} <span class="comment">// } // Session_base::Graceful_finisher::on_master_channel_hosed()</span></div>
<div class="line"><a id="l01124" name="l01124"></a><span class="lineno"> 1124</span> </div>
<div class="line"><a id="l01125" name="l01125"></a><span class="lineno"> 1125</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l01126" name="l01126"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#af441f45ce1ed7b890c3ab77d959f8830"> 1126</a></span><span class="keywordtype">void</span> CLASS_SESSION_BASE::Graceful_finisher::on_dtor_start()</div>
<div class="line"><a id="l01127" name="l01127"></a><span class="lineno"> 1127</span>{</div>
<div class="line"><a id="l01128" name="l01128"></a><span class="lineno"> 1128</span>  <span class="keyword">using </span>flow::async::Synchronicity;</div>
<div class="line"><a id="l01129" name="l01129"></a><span class="lineno"> 1129</span> </div>
<div class="line"><a id="l01130" name="l01130"></a><span class="lineno"> 1130</span>  <span class="comment">// We are in thread U.  In fact in we&#39;re in a Client/Server_session_impl dtor... but at its very start.</span></div>
<div class="line"><a id="l01131" name="l01131"></a><span class="lineno"> 1131</span> </div>
<div class="line"><a id="l01132" name="l01132"></a><span class="lineno"> 1132</span>  <span class="comment">/* Thread W must be fine and running; per algorithm (see Graceful_finisher class doc header).</span></div>
<div class="line"><a id="l01133" name="l01133"></a><span class="lineno"> 1133</span><span class="comment">   * It&#39;s only safe to access m_master_channel from there. */</span></div>
<div class="line"><a id="l01134" name="l01134"></a><span class="lineno"> 1134</span>  m_async_worker-&gt;post([&amp;]()</div>
<div class="line"><a id="l01135" name="l01135"></a><span class="lineno"> 1135</span>  {</div>
<div class="line"><a id="l01136" name="l01136"></a><span class="lineno"> 1136</span>    FLOW_LOG_INFO(<span class="stringliteral">&quot;In Session object dtor sending GracefulSessionEnd to opposing Session object along &quot;</span></div>
<div class="line"><a id="l01137" name="l01137"></a><span class="lineno"> 1137</span>                  <span class="stringliteral">&quot;session master channel [&quot;</span> &lt;&lt; *m_master_channel &lt;&lt; <span class="stringliteral">&quot;] -- if at all possible.&quot;</span>);</div>
<div class="line"><a id="l01138" name="l01138"></a><span class="lineno"> 1138</span> </div>
<div class="line"><a id="l01139" name="l01139"></a><span class="lineno"> 1139</span>    <span class="keyword">auto</span> msg = m_master_channel-&gt;create_msg();</div>
<div class="line"><a id="l01140" name="l01140"></a><span class="lineno"> 1140</span>    msg.body_root()-&gt;initGracefulSessionEnd();</div>
<div class="line"><a id="l01141" name="l01141"></a><span class="lineno"> 1141</span> </div>
<div class="line"><a id="l01142" name="l01142"></a><span class="lineno"> 1142</span>    <a class="code hl_typedef" href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">Error_code</a> err_code_ignored;</div>
<div class="line"><a id="l01143" name="l01143"></a><span class="lineno"> 1143</span>    m_master_channel-&gt;send(msg, <span class="keyword">nullptr</span>, &amp;err_code_ignored);</div>
<div class="line"><a id="l01144" name="l01144"></a><span class="lineno"> 1144</span>    <span class="comment">/* Whatever happened, it logged.  We make a best effort; it channel is hosed or send fails, then the other</span></div>
<div class="line"><a id="l01145" name="l01145"></a><span class="lineno"> 1145</span><span class="comment">     * side shall detect it via its on_master_channel_hosed() presumably and set its m_opposing_session_done, hence</span></div>
<div class="line"><a id="l01146" name="l01146"></a><span class="lineno"> 1146</span><span class="comment">     * its on_dtor_start() will proceed. */</span></div>
<div class="line"><a id="l01147" name="l01147"></a><span class="lineno"> 1147</span>  }, Synchronicity::S_ASYNC_AND_AWAIT_CONCURRENT_COMPLETION); <span class="comment">// m_async_worker-&gt;post()</span></div>
<div class="line"><a id="l01148" name="l01148"></a><span class="lineno"> 1148</span> </div>
<div class="line"><a id="l01149" name="l01149"></a><span class="lineno"> 1149</span>  <span class="comment">// That would&#39;ve been non-blocking.  So now lastly:</span></div>
<div class="line"><a id="l01150" name="l01150"></a><span class="lineno"> 1150</span> </div>
<div class="line"><a id="l01151" name="l01151"></a><span class="lineno"> 1151</span>  FLOW_LOG_INFO(<span class="stringliteral">&quot;In Session object dtor we not await sign that the opposing Session object dtor has also started; &quot;</span></div>
<div class="line"><a id="l01152" name="l01152"></a><span class="lineno"> 1152</span>                <span class="stringliteral">&quot;only then will we proceed with destroying our Session object: e.g., maybe they hold handles &quot;</span></div>
<div class="line"><a id="l01153" name="l01153"></a><span class="lineno"> 1153</span>                <span class="stringliteral">&quot;to objects in a SHM-arena we would deinitialize.  If their dtor has already been called, we will &quot;</span></div>
<div class="line"><a id="l01154" name="l01154"></a><span class="lineno"> 1154</span>                <span class="stringliteral">&quot;proceed immediately.  If not, we will now wait for that.  This would only block if the opposing &quot;</span></div>
<div class="line"><a id="l01155" name="l01155"></a><span class="lineno"> 1155</span>                <span class="stringliteral">&quot;side&#39;s user code neglects to destroy Session object on error; or has some kind of blocking &quot;</span></div>
<div class="line"><a id="l01156" name="l01156"></a><span class="lineno"> 1156</span>                <span class="stringliteral">&quot;operation in progress before destroying Session object.  &quot;</span></div>
<div class="line"><a id="l01157" name="l01157"></a><span class="lineno"> 1157</span>                <span class="stringliteral">&quot;Session master channel: [&quot;</span> &lt;&lt; *m_master_channel &lt;&lt; <span class="stringliteral">&quot;].&quot;</span>);</div>
<div class="line"><a id="l01158" name="l01158"></a><span class="lineno"> 1158</span>  m_opposing_session_done.get_future().wait();</div>
<div class="line"><a id="l01159" name="l01159"></a><span class="lineno"> 1159</span>  FLOW_LOG_INFO(<span class="stringliteral">&quot;In Session object dtor: Done awaiting sign that the opposing Session object dtor has also started.  &quot;</span></div>
<div class="line"><a id="l01160" name="l01160"></a><span class="lineno"> 1160</span>                <span class="stringliteral">&quot;Will now proceed with our Session object destruction.&quot;</span>);</div>
<div class="line"><a id="l01161" name="l01161"></a><span class="lineno"> 1161</span>} <span class="comment">// Session_base::Graceful_finisher::on_dtor_start()</span></div>
<div class="line"><a id="l01162" name="l01162"></a><span class="lineno"> 1162</span> </div>
<div class="line"><a id="l01163" name="l01163"></a><span class="lineno"> 1163</span><a class="code hl_define" href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div>
<div class="line"><a id="l01164" name="l01164"></a><span class="lineno"> 1164</span><span class="keyword">typename</span> CLASS_SESSION_BASE::Structured_msg_reader_config</div>
<div class="line"><a id="l01165" name="l01165"></a><span class="lineno"><a class="line" href="classipc_1_1session_1_1Session__base.html#a489bb6ec7726e39e78dcd4dd2fe3de75"> 1165</a></span>  CLASS_SESSION_BASE::heap_reader_config(flow::log::Logger* logger_ptr) <span class="comment">// Static.</span></div>
<div class="line"><a id="l01166" name="l01166"></a><span class="lineno"> 1166</span>{</div>
<div class="line"><a id="l01167" name="l01167"></a><span class="lineno"> 1167</span>  <span class="keywordflow">return</span> <a class="code hl_struct" href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">transport::struc::Heap_reader::Config</a>{ logger_ptr, 0 };</div>
<div class="line"><a id="l01168" name="l01168"></a><span class="lineno"> 1168</span>} <span class="comment">// Session_base::heap_reader_config()</span></div>
<div class="line"><a id="l01169" name="l01169"></a><span class="lineno"> 1169</span> </div>
<div class="line"><a id="l01170" name="l01170"></a><span class="lineno"> 1170</span><span class="preprocessor">#undef CLASS_SESSION_BASE</span></div>
<div class="line"><a id="l01171" name="l01171"></a><span class="lineno"> 1171</span><span class="preprocessor">#undef TEMPLATE_SESSION_BASE</span></div>
<div class="line"><a id="l01172" name="l01172"></a><span class="lineno"> 1172</span> </div>
<div class="line"><a id="l01173" name="l01173"></a><span class="lineno"> 1173</span>} <span class="comment">// namespace ipc::session</span></div>
<div class="ttc" id="aapp_8hpp_html"><div class="ttname"><a href="app_8hpp.html">app.hpp</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_1_1Graceful__finisher_html"><div class="ttname"><a href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html">ipc::session::Session_base::Graceful_finisher</a></div><div class="ttdoc">Optional to use by subclasses, this operates a simple state machine that carries out a graceful-sessi...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00575">session_base.hpp:578</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_1_1Graceful__finisher_html_a28a9c414cee99b868b2cd291cee24ea0"><div class="ttname"><a href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a28a9c414cee99b868b2cd291cee24ea0">ipc::session::Session_base::Graceful_finisher::Graceful_finisher</a></div><div class="ttdeci">Graceful_finisher(flow::log::Logger *logger_ptr, Session_base *this_session, flow::async::Single_thread_task_loop *async_worker, Master_structured_channel *master_channel)</div><div class="ttdoc">You must invoke this ctor (instantiate us) if and only if synchronized dtor execution is indeed requi...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l01070">session_base.hpp:1070</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_1_1Graceful__finisher_html_a5de1dea5af9f0ef5558e91ff6484e68d"><div class="ttname"><a href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a5de1dea5af9f0ef5558e91ff6484e68d">ipc::session::Session_base::Graceful_finisher::m_async_worker</a></div><div class="ttdeci">flow::async::Single_thread_task_loop * m_async_worker</div><div class="ttdoc">The containing Session thread W loop. It shall exist until *this is gone.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00634">session_base.hpp:634</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_1_1Graceful__finisher_html_a8dd106d9ac3223737dac58d0b056367b"><div class="ttname"><a href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#a8dd106d9ac3223737dac58d0b056367b">ipc::session::Session_base::Graceful_finisher::m_master_channel</a></div><div class="ttdeci">Master_structured_channel * m_master_channel</div><div class="ttdoc">The containing Session master channel. It shall exist until *this is gone.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00637">session_base.hpp:637</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_1_1Graceful__finisher_html_ab1548d77913d3e99e4f30e1dd46f8d86"><div class="ttname"><a href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#ab1548d77913d3e99e4f30e1dd46f8d86">ipc::session::Session_base::Graceful_finisher::m_opposing_session_done</a></div><div class="ttdeci">boost::promise&lt; void &gt; m_opposing_session_done</div><div class="ttdoc">A promise whose fulfillment is a necessary and sufficient condition for on_dtor_start() returning (le...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00647">session_base.hpp:647</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_1_1Graceful__finisher_html_acb037930b23240ecf8975e65f50f3927"><div class="ttname"><a href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#acb037930b23240ecf8975e65f50f3927">ipc::session::Session_base::Graceful_finisher::m_this_session</a></div><div class="ttdeci">Session_base *const m_this_session</div><div class="ttdoc">The containing Session_base. It shall exist until *this is gone.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00631">session_base.hpp:631</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_1_1Graceful__finisher_html_af441f45ce1ed7b890c3ab77d959f8830"><div class="ttname"><a href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#af441f45ce1ed7b890c3ab77d959f8830">ipc::session::Session_base::Graceful_finisher::on_dtor_start</a></div><div class="ttdeci">void on_dtor_start()</div><div class="ttdoc">The reason Graceful_finisher exists, this method must be called at the start of *_session_impl dtor; ...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l01126">session_base.hpp:1126</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_1_1Graceful__finisher_html_af7c591a4b774ae52603fa6d890e369f1"><div class="ttname"><a href="classipc_1_1session_1_1Session__base_1_1Graceful__finisher.html#af7c591a4b774ae52603fa6d890e369f1">ipc::session::Session_base::Graceful_finisher::on_master_channel_hosed</a></div><div class="ttdeci">void on_master_channel_hosed()</div><div class="ttdoc">Must be invoked if the *_session_impl detects that the master channel has emitted channel-hosing erro...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l01110">session_base.hpp:1110</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html">ipc::session::Session_base</a></div><div class="ttdoc">Internal type containing data and types common to internal types Server_session_impl and Client_sessi...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00067">session_base.hpp:69</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a08b3d69a6707dcbb233076b7a48de285"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a08b3d69a6707dcbb233076b7a48de285">ipc::session::Session_base::heap_fixed_builder_config</a></div><div class="ttdeci">static Structured_msg_builder_config heap_fixed_builder_config(flow::log::Logger *logger_ptr)</div><div class="ttdoc">See Session_mv::heap_fixed_builder_config() (1-arg).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l01020">session_base.hpp:1020</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a09cbe99083616bae00928f8e37c8373b"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a09cbe99083616bae00928f8e37c8373b">ipc::session::Session_base::cur_ns_store_mutex_absolute_name</a></div><div class="ttdeci">Shared_name cur_ns_store_mutex_absolute_name() const</div><div class="ttdoc">Computes the name of the interprocess named-mutex used to control reading/writing to the file storing...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00953">session_base.hpp:953</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a0d7926326671d05679c53e5e3991603e"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a0d7926326671d05679c53e5e3991603e">ipc::session::Session_base::m_peer_state_err_code_or_ok</a></div><div class="ttdeci">Error_code m_peer_state_err_code_or_ok</div><div class="ttdoc">Starts falsy; becomes forever truthy (with a specific Error_code that will not change thereafter) onc...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00806">session_base.hpp:806</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a1f7c4243c8bd55930f51a568884c8aaf"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a1f7c4243c8bd55930f51a568884c8aaf">ipc::session::Session_base::S_SOCKET_STREAM_ENABLED</a></div><div class="ttdeci">static constexpr bool S_SOCKET_STREAM_ENABLED</div><div class="ttdoc">See Session_mv.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00077">session_base.hpp:77</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a21b146b02d257d95f4aaeaca12b8d320"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a21b146b02d257d95f4aaeaca12b8d320">ipc::session::Session_base::on_passive_open_channel_func_or_empty</a></div><div class="ttdeci">const On_passive_open_channel_func &amp; on_passive_open_channel_func_or_empty() const</div><div class="ttdoc">The on-passive-open handler (may be empty even in final state, meaning user wants passive-opens disab...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00925">session_base.hpp:925</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a27a5731a648effb6b4b42f0312affa74"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a27a5731a648effb6b4b42f0312affa74">ipc::session::Session_base::S_MQS_ENABLED</a></div><div class="ttdeci">static constexpr bool S_MQS_ENABLED</div><div class="ttdoc">See Session_mv.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00074">session_base.hpp:74</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a28825fcdeaf1249a7bf810a3b2ca7c38"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a28825fcdeaf1249a7bf810a3b2ca7c38">ipc::session::Session_base::set_srv_namespace</a></div><div class="ttdeci">void set_srv_namespace(Shared_name &amp;&amp;srv_namespace_new)</div><div class="ttdoc">Sets srv_namespace() (do not call if already set).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00870">session_base.hpp:870</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a2985006a6526c86ce3ed5497cb7f5b64"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a2985006a6526c86ce3ed5497cb7f5b64">ipc::session::Session_base::m_cli_namespace</a></div><div class="ttdeci">Shared_name m_cli_namespace</div><div class="ttdoc">See cli_namespace().</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00789">session_base.hpp:789</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a35234981ca87cc2f6b118b3e52452ea8"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a35234981ca87cc2f6b118b3e52452ea8">ipc::session::Session_base::Mdt_payload_obj</a></div><div class="ttdeci">Mdt_payload Mdt_payload_obj</div><div class="ttdoc">See Session_mv (or Session concept).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00125">session_base.hpp:125</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a398f3e6a30b3fae8e110af9fd1ff75e3"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a398f3e6a30b3fae8e110af9fd1ff75e3">ipc::session::Session_base::hosed</a></div><div class="ttdeci">bool hosed() const</div><div class="ttdoc">Returns true if and only if hose() has been called.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00946">session_base.hpp:946</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a3be1a385c905404621b58c23332b0b96"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a3be1a385c905404621b58c23332b0b96">ipc::session::Session_base::set_on_passive_open_channel_func</a></div><div class="ttdeci">void set_on_passive_open_channel_func(On_passive_open_channel_func &amp;&amp;on_passive_open_channel_func)</div><div class="ttdoc">Sets on_passive_open_channel_func_or_empty() (do not call if already set; do not call if user intends...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00890">session_base.hpp:890</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a3c0824a54ef32915c5c5ea76481f2409"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a3c0824a54ef32915c5c5ea76481f2409">ipc::session::Session_base::On_passive_open_channel_func</a></div><div class="ttdeci">Function&lt; void(Channel_obj &amp;&amp;new_channel, Mdt_reader_ptr &amp;&amp;new_channel_mdt)&gt; On_passive_open_channel_func</div><div class="ttdoc">Concrete function type for the on-passive-open handler (if any), used for storage.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00372">session_base.hpp:373</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a3d34c5a9c283a6b7c8ab943f344cdd28"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a3d34c5a9c283a6b7c8ab943f344cdd28">ipc::session::Session_base::session_master_socket_stream_acceptor_absolute_name</a></div><div class="ttdeci">Shared_name session_master_socket_stream_acceptor_absolute_name() const</div><div class="ttdoc">Computes the absolute name at which the server shall set up a transport::Native_socket_stream_accepto...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00999">session_base.hpp:999</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a3ebdafe7e70719e6d12dd0b15ae85106"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a3ebdafe7e70719e6d12dd0b15ae85106">ipc::session::Session_base::cli_app_ptr</a></div><div class="ttdeci">const Client_app * cli_app_ptr() const</div><div class="ttdoc">See Server_session_impl, Client_session_impl.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00906">session_base.hpp:906</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a489bb6ec7726e39e78dcd4dd2fe3de75"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a489bb6ec7726e39e78dcd4dd2fe3de75">ipc::session::Session_base::heap_reader_config</a></div><div class="ttdeci">static Structured_msg_reader_config heap_reader_config(flow::log::Logger *logger_ptr)</div><div class="ttdoc">See Session_mv::heap_reader_config() (1-arg).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l01165">session_base.hpp:1165</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a4a7a5b83f6ba8bd505685636eabc012b"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a4a7a5b83f6ba8bd505685636eabc012b">ipc::session::Session_base::Mdt_builder_ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; Mdt_builder &gt; Mdt_builder_ptr</div><div class="ttdoc">See Session_mv (or Session concept).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00136">session_base.hpp:136</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a4d1327608d6067ed6690bd4efa323c6f"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a4d1327608d6067ed6690bd4efa323c6f">ipc::session::Session_base::srv_namespace</a></div><div class="ttdeci">const Shared_name &amp; srv_namespace() const</div><div class="ttdoc">See Server_session_impl, Client_session_impl.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00912">session_base.hpp:912</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a60a081ce0f85651202d23b4d543d093c"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a60a081ce0f85651202d23b4d543d093c">ipc::session::Session_base::set_cli_app_ptr</a></div><div class="ttdeci">void set_cli_app_ptr(const Client_app *cli_app_ptr_new)</div><div class="ttdoc">Sets cli_app_ptr() (do not call if already set).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00857">session_base.hpp:857</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a60a30526bad0c8db6ad05ede618a22bd"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a60a30526bad0c8db6ad05ede618a22bd">ipc::session::Session_base::m_srv_namespace</a></div><div class="ttdeci">Shared_name m_srv_namespace</div><div class="ttdoc">See srv_namespace().</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00786">session_base.hpp:786</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a638232ef74a0eb80aeb4f027ee06f9bf"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a638232ef74a0eb80aeb4f027ee06f9bf">ipc::session::Session_base::Channels</a></div><div class="ttdeci">std::vector&lt; Channel_obj &gt; Channels</div><div class="ttdoc">See Session_mv. Note: If changed from vector please update those doc headers too.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00122">session_base.hpp:122</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a71f02a809d667c23ff8af29a96940bd1"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a71f02a809d667c23ff8af29a96940bd1">ipc::session::Session_base::Channel_obj</a></div><div class="ttdeci">std::conditional_t&lt; S_MQS_ENABLED, std::conditional_t&lt; S_TRANSMIT_NATIVE_HANDLES, transport::Mqs_socket_stream_channel&lt; true, Persistent_mq_handle_from_cfg &gt;, transport::Mqs_channel&lt; true, Persistent_mq_handle_from_cfg &gt; &gt;, std::conditional_t&lt; S_TRANSMIT_NATIVE_HANDLES, transport::Socket_stream_channel&lt; true &gt;, transport::Socket_stream_channel_of_blobs&lt; true &gt; &gt; &gt; Channel_obj</div><div class="ttdoc">See Session_mv (or Session concept).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00111">session_base.hpp:119</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a7d25e45d33beb8af9ae03b05d676b0e4"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a7d25e45d33beb8af9ae03b05d676b0e4">ipc::session::Session_base::m_on_err_func</a></div><div class="ttdeci">flow::async::Task_asio_err m_on_err_func</div><div class="ttdoc">See set_on_err_func().</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00792">session_base.hpp:792</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a7d68bbb8c0c09983619d563bca30bd45"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a7d68bbb8c0c09983619d563bca30bd45">ipc::session::Session_base::Mdt_builder</a></div><div class="ttdeci">typename transport::struc::schema::Metadata&lt; Mdt_payload_obj &gt;::Builder Mdt_builder</div><div class="ttdoc">See Session_mv (or Session concept).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00132">session_base.hpp:133</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a7f9e67dccbab4f3191734c2834bafb63"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a7f9e67dccbab4f3191734c2834bafb63">ipc::session::Session_base::hose</a></div><div class="ttdeci">void hose(const Error_code &amp;err_code)</div><div class="ttdoc">Marks this session as hosed for (truthy) reason err_code; and synchronously invokes on-error handler;...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00937">session_base.hpp:937</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a848c0f5247644ada0f8b0ab816eedda8"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a848c0f5247644ada0f8b0ab816eedda8">ipc::session::Session_base::Persistent_mq_handle_from_cfg</a></div><div class="ttdeci">std::conditional_t&lt;!S_MQS_ENABLED, transport::Null_peer, std::conditional_t&lt; S_MQ_TYPE_OR_NONE==schema::MqType::POSIX, transport::Posix_mq_handle, transport::Bipc_mq_handle &gt; &gt; Persistent_mq_handle_from_cfg</div><div class="ttdoc">Relevant only if S_MQS_ENABLED, this is the Persistent_mq_handle-concept impl type specified by the u...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00103">session_base.hpp:108</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_a8cc7a4faa098e0f71c737f44c34d593c"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#a8cc7a4faa098e0f71c737f44c34d593c">ipc::session::Session_base::set_cli_namespace</a></div><div class="ttdeci">void set_cli_namespace(Shared_name &amp;&amp;cli_namespace_new)</div><div class="ttdoc">Sets cli_namespace() (do not call if already set).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00880">session_base.hpp:880</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_aa8cccc9369af1dff6b59dee1a12f72d8"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#aa8cccc9369af1dff6b59dee1a12f72d8">ipc::session::Session_base::m_cli_app_ptr</a></div><div class="ttdeci">std::atomic&lt; const Client_app * &gt; m_cli_app_ptr</div><div class="ttdoc">See cli_app_ptr().</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00783">session_base.hpp:783</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_aab2db8b2cdb3d8189c1cc497aed7b2b1"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#aab2db8b2cdb3d8189c1cc497aed7b2b1">ipc::session::Session_base::Session_base</a></div><div class="ttdeci">Session_base(const Client_app &amp;cli_app_ref, const Server_app &amp;srv_app_ref, flow::async::Task_asio_err &amp;&amp;on_err_func, On_passive_open_channel_func &amp;&amp;on_passive_open_channel_func_or_empty_arg)</div><div class="ttdoc">Constructs: Client_session_impl form (the user is the one constructing the object,...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00819">session_base.hpp:819</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_abd1e814b3b640f4bdaa2553352405f26"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#abd1e814b3b640f4bdaa2553352405f26">ipc::session::Session_base::cli_namespace</a></div><div class="ttdeci">const Shared_name &amp; cli_namespace() const</div><div class="ttdoc">See Server_session_impl, Client_session_impl.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00918">session_base.hpp:918</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_aca82817beaac36d0006c44012f9fef03"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#aca82817beaac36d0006c44012f9fef03">ipc::session::Session_base::on_err_func_set</a></div><div class="ttdeci">bool on_err_func_set() const</div><div class="ttdoc">Returns true if and only if set_on_err_func() has been called.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00931">session_base.hpp:931</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_ace4dab42adec6354cc66081dd218ac71"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#ace4dab42adec6354cc66081dd218ac71">ipc::session::Session_base::Mdt_reader_ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; typename transport::struc::schema::Metadata&lt; Mdt_payload_obj &gt;::Reader &gt; Mdt_reader_ptr</div><div class="ttdoc">See Session_mv (or Session concept).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00128">session_base.hpp:129</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_ad28de3ad7ea872adb52e3a826602d333"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#ad28de3ad7ea872adb52e3a826602d333">ipc::session::Session_base::m_on_passive_open_channel_func_or_empty</a></div><div class="ttdeci">On_passive_open_channel_func m_on_passive_open_channel_func_or_empty</div><div class="ttdoc">See on_passive_open_channel_func_or_empty().</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00795">session_base.hpp:795</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_ae2a123b29dd044a638e94d1f294c8f28"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#ae2a123b29dd044a638e94d1f294c8f28">ipc::session::Session_base::Master_structured_channel_observer</a></div><div class="ttdeci">boost::weak_ptr&lt; Master_structured_channel &gt; Master_structured_channel_observer</div><div class="ttdoc">Observer of Master_structured_channel_ptr. See its doc header.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00369">session_base.hpp:369</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_ae68b7b80ff82ba5cde28a53fa52a5095"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#ae68b7b80ff82ba5cde28a53fa52a5095">ipc::session::Session_base::S_OPEN_CHANNEL_TIMEOUT</a></div><div class="ttdeci">static constexpr util::Fine_duration S_OPEN_CHANNEL_TIMEOUT</div><div class="ttdoc">Internal timeout for open_channel().</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00262">session_base.hpp:262</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_ae769a82bdec0d16702111ad06716faae"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#ae769a82bdec0d16702111ad06716faae">ipc::session::Session_base::set_on_err_func</a></div><div class="ttdeci">void set_on_err_func(flow::async::Task_asio_err &amp;&amp;on_err_func_arg)</div><div class="ttdoc">Sets on_err_func() (do not call if already set).</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00897">session_base.hpp:897</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_af059faab56cdf384873f9f2aba8f79cf"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#af059faab56cdf384873f9f2aba8f79cf">ipc::session::Session_base::cur_ns_store_absolute_path</a></div><div class="ttdeci">fs::path cur_ns_store_absolute_path() const</div><div class="ttdoc">Computes the absolute path to file storing (written by server, read by client) the value for srv_name...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00986">session_base.hpp:986</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_af0b52934c6b1204cb3ba676480727d27"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#af0b52934c6b1204cb3ba676480727d27">ipc::session::Session_base::S_MQS_MAX_MSG_SZ</a></div><div class="ttdeci">static constexpr size_t S_MQS_MAX_MSG_SZ</div><div class="ttdoc">The max sendable MQ message size as decided by Server_session_impl::make_channel_mqs() (and imposed o...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00321">session_base.hpp:321</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_af0ca2a01d7d0d92038aae56fc1cdd505"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#af0ca2a01d7d0d92038aae56fc1cdd505">ipc::session::Session_base::Master_structured_channel_ptr</a></div><div class="ttdeci">boost::shared_ptr&lt; Master_structured_channel &gt; Master_structured_channel_ptr</div><div class="ttdoc">Handle to Master_structured_channel.</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00366">session_base.hpp:366</a></div></div>
<div class="ttc" id="aclassipc_1_1session_1_1Session__base_html_afd32d90b86d699263a0f02637dd7c6c6"><div class="ttname"><a href="classipc_1_1session_1_1Session__base.html#afd32d90b86d699263a0f02637dd7c6c6">ipc::session::Session_base::m_srv_app_ref</a></div><div class="ttdeci">const Server_app &amp; m_srv_app_ref</div><div class="ttdoc">Reference to Server_app (referring to local process in Server_session_impl, opposing process in Clien...</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00243">session_base.hpp:243</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Bipc__mq__handle_html"><div class="ttname"><a href="classipc_1_1transport_1_1Bipc__mq__handle.html">ipc::transport::Bipc_mq_handle</a></div><div class="ttdoc">Implements the Persistent_mq_handle concept by thinly wrapping bipc::message_queue,...</div><div class="ttdef"><b>Definition:</b> <a href="bipc__mq__handle_8hpp_source.html#l00050">bipc_mq_handle.hpp:52</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Mqs__channel_html"><div class="ttname"><a href="classipc_1_1transport_1_1Mqs__channel.html">ipc::transport::Mqs_channel</a></div><div class="ttdoc">A Channel with at least a blobs pipe consisting of two MQs of type Persistent_mq_handle (template arg...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html#l01174">channel.hpp:1180</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Mqs__socket__stream__channel_html"><div class="ttname"><a href="classipc_1_1transport_1_1Mqs__socket__stream__channel.html">ipc::transport::Mqs_socket_stream_channel</a></div><div class="ttdoc">A Channel with a blobs pipe consisting of 2 MQs of type Persistent_mq_handle (template arg); and a ha...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html#l01273">channel.hpp:1278</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Native__socket__stream__acceptor_html_a0de2b6072026584ff1d46538533ed68b"><div class="ttname"><a href="classipc_1_1transport_1_1Native__socket__stream__acceptor.html#a0de2b6072026584ff1d46538533ed68b">ipc::transport::Native_socket_stream_acceptor::S_RESOURCE_TYPE_ID</a></div><div class="ttdeci">static const Shared_name &amp; S_RESOURCE_TYPE_ID</div><div class="ttdoc">Shared_name relative-folder fragment (no separators) identifying this resource type.</div><div class="ttdef"><b>Definition:</b> <a href="native__socket__stream__acceptor_8hpp_source.html#l00120">native_socket_stream_acceptor.hpp:120</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Null__peer_html"><div class="ttname"><a href="classipc_1_1transport_1_1Null__peer.html">ipc::transport::Null_peer</a></div><div class="ttdoc">Dummy type for use as a template param to Channel when either the blobs pipe or handles pipe is disab...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html#l00999">channel.hpp:1000</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Posix__mq__handle_html"><div class="ttname"><a href="classipc_1_1transport_1_1Posix__mq__handle.html">ipc::transport::Posix_mq_handle</a></div><div class="ttdoc">Implements the Persistent_mq_handle concept by wrapping the POSIX message queue API (see man mq_overv...</div><div class="ttdef"><b>Definition:</b> <a href="posix__mq__handle_8hpp_source.html#l00061">posix_mq_handle.hpp:63</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Socket__stream__channel__of__blobs_html"><div class="ttname"><a href="classipc_1_1transport_1_1Socket__stream__channel__of__blobs.html">ipc::transport::Socket_stream_channel_of_blobs</a></div><div class="ttdoc">A Channel with a blobs pipe only (no handles pipe) that uses a Unix domain socket connection as the u...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html#l01093">channel.hpp:1097</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1Socket__stream__channel_html"><div class="ttname"><a href="classipc_1_1transport_1_1Socket__stream__channel.html">ipc::transport::Socket_stream_channel</a></div><div class="ttdoc">A Channel with a handles pipe only (no blobs pipe) that uses a Unix domain socket connection as the u...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2transport_2channel_8hpp_source.html#l01025">channel.hpp:1029</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Channel_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Channel.html">ipc::transport::struc::Channel</a></div><div class="ttdoc">Owning and wrapping a pre-connected transport::Channel peer (an endpoint of an established channel ov...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp_source.html#l00580">channel.hpp:583</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Channel_html_a160a8d49624f15a2596ee7b0244584b0"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Channel.html#a160a8d49624f15a2596ee7b0244584b0">ipc::transport::struc::Channel::expect_msg</a></div><div class="ttdeci">bool expect_msg(Msg_which_in which, On_msg_handler &amp;&amp;on_msg_func)</div><div class="ttdoc">Registers the expectation of up to 1 notification in-message whose Msg_which equals which.</div><div class="ttdef"><b>Definition:</b> <a href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp_source.html#l02062">channel.hpp:2062</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1struc_1_1Heap__fixed__builder_html"><div class="ttname"><a href="classipc_1_1transport_1_1struc_1_1Heap__fixed__builder.html">ipc::transport::struc::Heap_fixed_builder</a></div><div class="ttdoc">Implements Struct_builder concept by straightforwardly allocating fixed-size segments on-demand in th...</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00130">heap_serializer.hpp:132</a></div></div>
<div class="ttc" id="aclassipc_1_1transport_1_1sync__io_1_1Native__socket__stream_html"><div class="ttname"><a href="classipc_1_1transport_1_1sync__io_1_1Native__socket__stream.html">ipc::transport::sync_io::Native_socket_stream</a></div><div class="ttdoc">Implements both sync_io::Native_handle_sender and sync_io::Native_handle_receiver concepts by using a...</div><div class="ttdef"><b>Definition:</b> <a href="sync__io_2native__socket__stream_8hpp_source.html#l00150">native_socket_stream.hpp:151</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html">ipc::util::Shared_name</a></div><div class="ttdoc">String-wrapping abstraction representing a name uniquely distinguishing a kernel-persistent entity fr...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00241">shared_name.hpp:242</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a43205a00865429c1bef6c7896816bf5c"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a43205a00865429c1bef6c7896816bf5c">ipc::util::Shared_name::S_SENTINEL</a></div><div class="ttdeci">static const Shared_name S_SENTINEL</div><div class="ttdoc">A Shared_name fragment, with no S_SEPARATOR characters inside, that represents a path component that ...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00280">shared_name.hpp:280</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a48f20b7b54490aa10dc64081d34c55b2"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a48f20b7b54490aa10dc64081d34c55b2">ipc::util::Shared_name::ct</a></div><div class="ttdeci">static Shared_name ct(const Source &amp;src)</div><div class="ttdoc">Copy-constructs from a char-sequence container (including string, util::String_view,...</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00674">shared_name.hpp:674</a></div></div>
<div class="ttc" id="aclassipc_1_1util_1_1Shared__name_html_a50cb5d2ad8f8b4391e1885e7b8f63890"><div class="ttname"><a href="classipc_1_1util_1_1Shared__name.html#a50cb5d2ad8f8b4391e1885e7b8f63890">ipc::util::Shared_name::S_RESOURCE_TYPE_ID_MUTEX</a></div><div class="ttdeci">static const Shared_name S_RESOURCE_TYPE_ID_MUTEX</div><div class="ttdoc">Relative-folder fragment (no separators) identifying the resource type for: boost....</div><div class="ttdef"><b>Definition:</b> <a href="shared__name_8hpp_source.html#l00315">shared_name.hpp:315</a></div></div>
<div class="ttc" id="adetail_2session__fwd_8hpp_html"><div class="ttname"><a href="detail_2session__fwd_8hpp.html">session_fwd.hpp</a></div></div>
<div class="ttc" id="aipc__session_2src_2ipc_2session_2error_8hpp_html"><div class="ttname"><a href="ipc__session_2src_2ipc_2session_2error_8hpp.html">error.hpp</a></div></div>
<div class="ttc" id="aipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp_html"><div class="ttname"><a href="ipc__transport__structured_2src_2ipc_2transport_2struc_2channel_8hpp.html">channel.hpp</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_1_1error_html_a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759"><div class="ttname"><a href="namespaceipc_1_1session_1_1error.html#a0708d4bec9ae853f4d7e3d7822fc8f2fa24eaed39f149e32f6ceaad54d24f8759">ipc::session::error::Code::S_SESSION_FINISHED</a></div><div class="ttdeci">@ S_SESSION_FINISHED</div><div class="ttdoc">The opposing end of the session in question has been closed gracefully by the user invoking the end-s...</div></div>
<div class="ttc" id="anamespaceipc_1_1session_html"><div class="ttname"><a href="namespaceipc_1_1session.html">ipc::session</a></div><div class="ttdoc">Flow-IPC module providing the broad lifecycle and shared-resource organization – via the session conc...</div><div class="ttdef"><b>Definition:</b> <a href="app_8cpp_source.html#l00026">app.cpp:27</a></div></div>
<div class="ttc" id="anamespaceipc_1_1session_html_a365d2d63f77b738e67e206af6b702634"><div class="ttname"><a href="namespaceipc_1_1session.html#a365d2d63f77b738e67e206af6b702634">ipc::session::build_conventional_shared_name</a></div><div class="ttdeci">Shared_name build_conventional_shared_name(const Shared_name &amp;resource_type, const Shared_name &amp;srv_app_name, const Shared_name &amp;srv_namespace, const Shared_name &amp;cli_app_name, const Shared_name &amp;cli_namespace_or_sentinel)</div><div class="ttdoc">Builds an absolute name according to the path convention explained in Shared_name class doc header; t...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__session_2src_2ipc_2session_2detail_2session__shared__name_8cpp_source.html#l00043">session_shared_name.cpp:44</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1classic_html_abfde278018c84aa1542475e9a4089c29"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#abfde278018c84aa1542475e9a4089c29">ipc::transport::struc::shm::classic::Builder</a></div><div class="ttdeci">Builder&lt; ipc::shm::classic::Pool_arena &gt; Builder</div><div class="ttdoc">Convenience alias: transport::struc::shm::Builder that works with boost.ipc.shm pools from ipc::shm::...</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2classic_2classic__fwd_8hpp_source.html#l00036">classic_fwd.hpp:36</a></div></div>
<div class="ttc" id="anamespaceipc_1_1transport_1_1struc_1_1shm_1_1classic_html_af94f8698ca62a84d6366aaa931375d41"><div class="ttname"><a href="namespaceipc_1_1transport_1_1struc_1_1shm_1_1classic.html#af94f8698ca62a84d6366aaa931375d41">ipc::transport::struc::shm::classic::Reader</a></div><div class="ttdeci">Reader&lt; ipc::shm::classic::Pool_arena &gt; Reader</div><div class="ttdoc">Convenience alias: transport::struc::shm::Reader that works with boost.ipc.shm pools from ipc::shm::c...</div><div class="ttdef"><b>Definition:</b> <a href="transport_2struc_2shm_2classic_2classic__fwd_8hpp_source.html#l00039">classic_fwd.hpp:39</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_aaaa1fe31f8d77f78345dec8fc95e9882"><div class="ttname"><a href="namespaceipc_1_1util.html#aaaa1fe31f8d77f78345dec8fc95e9882">ipc::util::IPC_KERNEL_PERSISTENT_RUN_DIR</a></div><div class="ttdeci">const fs::path IPC_KERNEL_PERSISTENT_RUN_DIR</div><div class="ttdoc">Absolute path to the directory (without trailing separator) in the file system where kernel-persisten...</div><div class="ttdef"><b>Definition:</b> <a href="ipc__core_2src_2ipc_2util_2detail_2util_8cpp_source.html#l00063">util.cpp:63</a></div></div>
<div class="ttc" id="anamespaceipc_1_1util_html_ac66141280c3b7295a86b65209f31cc58"><div class="ttname"><a href="namespaceipc_1_1util.html#ac66141280c3b7295a86b65209f31cc58">ipc::util::Fine_duration</a></div><div class="ttdeci">flow::Fine_duration Fine_duration</div><div class="ttdoc">Short-hand for Flow's Fine_duration.</div><div class="ttdef"><b>Definition:</b> <a href="util__fwd_8hpp_source.html#l00117">util_fwd.hpp:117</a></div></div>
<div class="ttc" id="anamespaceipc_html_a4ccdeed058222c635745a4dc830e99f7"><div class="ttname"><a href="namespaceipc.html#a4ccdeed058222c635745a4dc830e99f7">ipc::Log_component</a></div><div class="ttdeci">Log_component</div><div class="ttdoc">The flow::log::Component payload enumeration containing various log components used by Flow-IPC inter...</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00322">common.hpp:323</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa3192e586cc45d3e7c22463bf2760f89"><div class="ttname"><a href="namespaceipc.html#aa3192e586cc45d3e7c22463bf2760f89">ipc::Error_code</a></div><div class="ttdeci">flow::Error_code Error_code</div><div class="ttdoc">Short-hand for flow::Error_code which is very common.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00298">common.hpp:298</a></div></div>
<div class="ttc" id="anamespaceipc_html_aa455c7f045059736578ca275fc1a851f"><div class="ttname"><a href="namespaceipc.html#aa455c7f045059736578ca275fc1a851f">ipc::Function</a></div><div class="ttdeci">flow::Function&lt; Signature &gt; Function</div><div class="ttdoc">Short-hand for polymorphic functor holder which is very common. This is essentially std::function.</div><div class="ttdef"><b>Definition:</b> <a href="common_8hpp_source.html#l00302">common.hpp:302</a></div></div>
<div class="ttc" id="anative__socket__stream__acceptor_8hpp_html"><div class="ttname"><a href="native__socket__stream__acceptor_8hpp.html">native_socket_stream_acceptor.hpp</a></div></div>
<div class="ttc" id="asession__base_8hpp_html_a08ab71c9690fedcb41f9695c3ad60f52"><div class="ttname"><a href="session__base_8hpp.html#a08ab71c9690fedcb41f9695c3ad60f52">TEMPLATE_SESSION_BASE</a></div><div class="ttdeci">#define TEMPLATE_SESSION_BASE</div><div class="ttdoc">Internally used macro; public API users should disregard (same deal as in struc/channel....</div><div class="ttdef"><b>Definition:</b> <a href="session__base_8hpp_source.html#l00810">session_base.hpp:810</a></div></div>
<div class="ttc" id="asession__shared__name_8hpp_html"><div class="ttname"><a href="session__shared__name_8hpp.html">session_shared_name.hpp</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Client__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Client__app.html">ipc::session::Client_app</a></div><div class="ttdoc">An App that is used as a client in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00184">app.hpp:185</a></div></div>
<div class="ttc" id="astructipc_1_1session_1_1Server__app_html"><div class="ttname"><a href="structipc_1_1session_1_1Server__app.html">ipc::session::Server_app</a></div><div class="ttdoc">An App that is used as a server in at least one client-server IPC split.</div><div class="ttdef"><b>Definition:</b> <a href="app_8hpp_source.html#l00205">app.hpp:206</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config_html"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__fixed__builder_1_1Config.html">ipc::transport::struc::Heap_fixed_builder::Config</a></div><div class="ttdoc">Implements Struct_builder::Config sub-concept.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00154">heap_serializer.hpp:155</a></div></div>
<div class="ttc" id="astructipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config_html"><div class="ttname"><a href="structipc_1_1transport_1_1struc_1_1Heap__reader_1_1Config.html">ipc::transport::struc::Heap_reader::Config</a></div><div class="ttdoc">Implements Struct_reader::Config sub-concept.</div><div class="ttdef"><b>Definition:</b> <a href="heap__serializer_8hpp_source.html#l00332">heap_serializer.hpp:333</a></div></div>
<div class="ttc" id="async__io_2native__socket__stream_8hpp_html"><div class="ttname"><a href="sync__io_2native__socket__stream_8hpp.html">native_socket_stream.hpp</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Fri Apr 11 2025 20:02:26 for Flow-IPC by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.4
</small></address>
</body>
</html>
